C++ Syntax

MKI_RESULTVALUE

MKI_EnumerateEntityAttrib(

MKI_CONST_ENTITY_PTR f_pEntity,

__int32 f_nMode,

MKI_ENUMATTRIB_PROC f_fnCallBack,

void* f_pUserData,

__int32* f_pAttribCount );

Enumerates all attributes of the given entity.

Parameters

Entity

[MKI_CONST_ENTITY_PTR] Address of the entity whose attributes shall be enumerated.

Mode

[__int32] Determines the type(s) of attributes that shall be enumerated (see MKI_ATTRIBMODE_*).

CallBack

[MKI_ENUMATTRIB_PROC] Callback procedure for an attribute enumeration. This procedure will be called for every enumeration step. For a detailed description of attribute enumeration, see also the description of the MKI_EnumAttribProc procedure.

If CallBack is nullptr, the attributes will not be enumerated, but the attribute number will still be returned. This can be used to determine whether an entity has attributes (and how many).

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.

AttributCount New in Version 2022.1

[__int32*] Address of an integer to receive the number of attributes enumerated, or nullptr if unused.

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 attribute enumeration, see the description of the corresponding callback procedure MKI_EnumAttribProc.