L_MrcEnumSegments

HSEGMENTATION hSegment;

segmentation handle

pMRCENUMSEGMENTSPROC pEnumProc;

callback function

L_HANDLE pUserData;

pointer to additional parameters

L_UINT32 dwFlags;

reserved flags

Parameter

Description

hSegment

An existing segmentation handle. This handle is obtained by calling the L_MrcStartBitmapSegmentation function.

pEnumProc

Pointer to a callback function called for each enumerated segment.

The callback function must adhere to the function prototype described in the MRCENUMSEGMENTSPROC function.

pUserData

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.

dwFlags

Reserved for future use. Pass 0.

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.

LTSGM

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.