C++ Syntax

MKI_RESULTVALUE

MKI_EnumerateIdent(

MKI_CONST_ENTITY_GROUP_PTR f_pGroup,

MKI_ENUMIDENT_PROC f_fnCallBack,

bool f_fAll,

void* f_pUserData );

Enumerates the addresses of all identified objects (only valid for multi-entity-identification).

Parameters

Group

[MKI_CONST_ENTITY_GROUP_PTR] Address of the group to be enumerated.

CallBack

[MKI_ENUMIDENT_PROC] Callback procedure for the group enumeration. This procedure will be called for every enumeration step. For a detailed description of identification enumeration, see also the description of the MKI_EnumIdentProc procedure.

All

[bool] If true, all nested sub-groups will be parsed and their contained non-group entities will enumerated as single entities. Otherwise, only the top-level entities (including possible sub-groups) will be enumerated.

UserData

[void*] This pointer will be passed to all callback procedures that are called during the enumeration. You can use this parameter to pass "local" data to the enumeration, preferably by passing a pointer to a local data structure containing all information the callback procedure requires.

Return Value Changed in Version 2022.1

Enumeration result as a bitwise-or combination of flags (see MKI_RESULT_*). Some results indicate minor problems and do NOT mean that the enumeration was stopped or unsuccessful!

Comment

For a detailed description of identification enumeration, see the description of the corresponding callback procedure MKI_EnumIdentProc.