Brief Index      Full Index      Events Index      I.M. Reference

Show_Sample_Max_Length

Functions

int Show_Sample_Max_Length (void)
 

Detailed Description

Function Documentation

int Show_Sample_Max_Length ( void  )

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

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

DETAILS

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.

NOTES

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.

RESTRICTIONS

See Also
Begin_Buffered_Selection, End_Buffered_Selection, Collect_Area_Samples, Find_Next_Sample

Brief Index      Full Index      Events Index      I.M. Reference