pMRCENUMSEGMENTSPROC

Summary

Handles each enumerated segment. The address of this callback is passed as an argument in L_MrcEnumSegments.

Syntax

#include "ltsgm.h"

L_INT pEXT_CALLBACK YourFunction(hSegment, pSegment, nSegId, pUserData)

Parameters

HSEGMENTATION hSegment

Handle to an existing segmentation handle. This handle is obtained by calling the L_MrcStartBitmapSegmentation function.

const pSEGMENTDATA pSegment

Pointer to a SEGMENTDATA structure that contains segment data for the segment being enumerated.

L_INT nSegId

ID of the segment being enumerated.

L_VOID * pUserData

A void pointer that you can use to access a variable or structure containing data that your callback function needs. This gives you a way to receive data indirectly from the function that uses this callback function. (This is the same pointer that you pass in the pUserData parameter of L_MrcEnumSegments.)

Keep in mind that this is a void pointer, which must be cast to the appropriate data type within your callback function.

Returns

Value	Meaning
SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This callback function is called for each segment enumerated by the L_MrcEnumSegments function. The callback receives segment data, segment ID and any other associated user data for each segment.

This callback is valid with auto and manual segmentation.

Required DLLs and Libraries

• 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.

See Also

Functions

• L_MrcStartBitmapSegmentation
• L_MrcStopBitmapSegmentation
• L_MrcSegmentBitmap
• L_MrcCreateNewSegment
• L_MrcCombineSegments
• L_MrcSetSegmentData
• L_MrcDeleteSegment
• L_MrcEnumSegments
• L_MrcSaveBitmap

Topics

• MRC Bitmap Functions: Manipulating Segments

Example

For an example, refer to L_MrcSetSegmentData.