References ▼
Enumerates the segments.
#include "ltsgm.h"
L_LTSGM_API L_INT L_MrcEnumSegments(hSegment, pEnumProc, pUserData, dwFlags)
An existing segmentation handle. This handle is obtained by calling the L_MrcStartBitmapSegmentation function.
Pointer to a callback function called for each enumerated segment.
The callback function must adhere to the function prototype described in the MRCENUMSEGMENTSPROC function.
Handle pointer that you can use to pass one or more additional parameters that the callback function needs.
To use this feature, assign a value to a variable or create a structure that contains as many fields as you need. Then, in this parameter, pass the address of the variable or structure, casting it to L_HANDLE. The callback function, which receives the address in its own pUserData parameter, can cast it to a pointer of the appropriate data type to access your variable or structure. If the additional parameters are not needed, you can pass NULL in this parameter.
Reserved for future use. Pass 0.
| Value | Meaning |
|---|---|
| SUCCESS | The function was successful. (pEnumProc was not NULL) |
| >= 1 | If pEnumProc was NULL, this is the number of segments. |
| < 1 | An error occurred. Refer to Return Codes. |
Use this function to enumerate all segments using the MRCENUMSEGMENTSPROC callback function. This function is valid with all of the segmentation processes.
Call the L_MrcStartBitmapSegmentation function before using any of the segmentation functions. When the handle to the segmentation is no longer needed, free it by calling the L_MrcStopBitmapSegmentation function.
For an example, refer to L_MrcSetSegmentData.