C++ Syntax

MKI_RESULTVALUE

MKI_EnumerateFlag(

__int32 f_nEnumFlag1,

__int32 f_nEnumFlag2,

MKI_ENUMIDENT_PROC f_fnCallBack,

bool f_fReversed,

void* f_pUserData );

Enumerates the addresses of all objects with a given flag status.

Parameters

EnumFlag1

EnumFlag2

[__int32] Two flag combinations used to filter special entities for the enumeration. The enumeration will only include entities where the following boolean expression is true:

( (Entity->Header.Flag & EnumFlag1 ) == EnumFlag2 )

Both values can be a bit-wise OR combination of MKI_FLAG_* flags. Typical combinations of EnumFlag1 and EnumFlag2 are:

EnumFlag1 = MKI_FLAG_SELECT, EnumFlag2 = MKI_FLAG_SELECT

Enumerate only permanently selected entities.

EnumFlag1 = MKI_FLAG_USE, EnumFlag2 = MKI_FLAG_USE

Enumerate only identified entities.

EnumFlag1 = MKI_FLAG_USE | MKI_FLAG_LOCKED | MKI_FLAG_NODISPLAY, EnumFlag2 = MKI_FLAG_USE

Enumerate only identified entities that are neither invisible nor locked.

CallBack

[MKI_ENUMIDENT_PROC] Callback procedure for an identification 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.

Reversed

[bool] If false, the objects will be enumerated starting by the oldest object, else the enumeration starts with the latest object.

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.