C++ Syntax

MKI_RESULTVALUE

MKI_EnumerateBlockAttrib(

const LPCWSTR f_pszBlockName,

const LPCWSTR f_pszLibraryName,

__int32 f_nMode,

MKI_ENUMATTRIB_PROC f_fnCallBack,

void* f_pUserData,

__int32* f_pAttribCount );

Enumerates all attributes of the given block. Blocks can only contain global and local attributes.

Parameters

BlockName

[const LPCWSTR] Name of the block whose attributes shall be enumerated.

LibraryName

[const LPCWSTR] Name of the library the block is located in.

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 a block 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.

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.