HC_Show_Sample_Max_Length

int HC_Show_Sample_Max_Length()
int HC_Show_Sample_Max_Length()

Returns the maximum number of keys that will be returned by a call to Find_Next_Sample.

Given a current list of selection buffer samples that were created by a call to Collect_Area_Samples, this function returns the maximum number of keys that will be returned by a call to Find_Next_Sample.

This allows you to pre-allocate an array that is equal to the size of the maximum number of keys.

This function is only valid when called during an active buffered selection and after a call to Collect_Area_Samples. If the buffered selection process has been terminated by a call to End_Buffered_Selection, this function will have no effect.

HC_Begin_Buffered_Selection, HC_End_Buffered_Selection, HC_Collect_Area_Samples, HC_Find_Next_Sample

Returns

The maximum number of keys that will be returned by a call to Find_Next_Sample.