In This Topic ▼

LMarker::Enum

Summary

Enumerates the markers in the object's marker collection.

Syntax

#include "ltwrappr.h"

virtual L_INT LMarker::Enum(uFlags)

Parameters

L_UINT uFlags

Reserved for future use. Pass 0.

Returns

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

Comments

This function actually updates the metadata marker collection as changes (deletions, insertions, etc.) take place. Therefore, when this function successfully returns, the contents of the resulting marker collection may be different from the contents of the marker collection when LMarker::Enum was called..

This function can also be used to selectively delete markers from the object's marker collection.

LMarker::EnumMarkersCallBack will be called for every marker in the collection. You can delete, replace or insert markers using the callback.

You can call the LEADMARKERCALLBACK from your callback to insert a marker. The marker will be inserted before the current marker.

You can think of this function as though the LEAD engine is creating a new collection of markers. If LMarker::EnumMarkersCallBack returns SUCCESS, the marker passed to it will be included in the resulting marker collection by pfnLEADCallback. This resulting marker collection will be contained by this object when the LMarker::Enum function successfully returns. You can also call pfnLEADCallback yourself if you want to insert extra markers or to control the order in which the markers are written.