C++ Syntax

MKI_RESULTVALUE

MKI_EnumerateBlock(

const LPCWSTR f_pszBlockName,

const LPCWSTR f_pszLibraryName,

MKI_CONST_XPROPERTY_PTR f_rXProperty,

__int64 f_nEnumMode,

MKI_ENUMOBJECT_PROC f_fnCallBack,

void* f_pUserData );

Enumerates a single block definition.

Parameters

BlockName

[const LPCWSTR] Name of the block to be enumerated.

LibraryName

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

XProperty New in Version 2018.2

[MKI_CONST_XPROPERTY_PTR] Address of optional extended properties to be transmitted to the block's objects. If nullptr, no properties will be transmitted.

EnumMode Changed in Version 6.60

[__int64] This value determines the way that entities are enumerated. It indicates what types of geometrical data the plug-in can handle, and what type of entities shall be enumerated. It can be a bit-wise OR combination of multiple flags (see MKI_ENUM_*).

CallBack

[MKI_ENUMOBJECT_PROC] Callback procedure for an object enumeration. This procedure will be called for every enumeration step. For a detailed description of object enumeration, see also the description of the MKI_EnumObjectProc procedure.

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