C++ Syntax

MKI_RESULTVALUE

MKI_EnumerateHatchBlock(

MKI_CONST_BUFFER_REF f_rData,

MKI_CONST_HATCHDEF_REF f_rHatchDef,

MKI_CONST_POINT_PTR f_pHatchOrigin,

MKI_CONST_XPROPERTY_PTR f_pXProperty,

MKI_HATCHOPENPATH_PROC f_fnOpenPathCallBack,

MKI_HATCHADDOBJECT_PROC f_fnAddObjectCallBack,

MKI_HATCHCLOSEPATH_PROC f_fnClosePathCallBack,

void* f_pUserData );

Enumerates the results of a block-based hatching of the data stored in the buffer pointed to by Data.

Parameters

Data

[MKI_CONST_BUFFER_REF] Address of a structure containing information about the data that is to be hatched. On how to create such a buffer, see MKI_BufferAlloc.

HatchDef

[MKI_CONST_HATCHDEF_REF] Address of a structure that contains a hatching type. Only the structure elements concerning block-based hatching will be used.

HatchOrigin

[MKI_CONST_POINT_PTR] Address of a point containing the hatch origin, i.e. the point to which the hatching shall be aligned, in internal [mm] relative to the page's center. If HatchOrigin is nullptr, the current hatch origin of the active drawing will be used.

XProperty New in Version 6.51

[MKI_CONST_XPROPERTY_PTR] Address of optional extended properties to be transmitted to the hatching. If nullptr, no properties will be transmitted.

OpenPathCallBack

[MKI_HATCHOPENPATH_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_HatchOpenPathProc procedure.

AddObjectCallBack

[MKI_HATCHADDOBJECT_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_HatchAddObjectProc procedure.

ClosePathCallBack

[MKI_HATCHCLOSEPATH_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_HatchClosePathProc procedure.

UserData New in Version 2014.0

[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 bit-wise OR combination of flags (see MKI_RESULT_*). Some results indicate minor problems and do NOT mean that the enumeration was stopped or unsuccessful!

Comment

Use MKI_BufferAlloc to create the buffer and MKI_BufferAddEnumerate or MKI_BufferAddEntity to add objects to it. Before calling this function you must also call MKI_BufferPrepare which prepares the data stored in the buffer for further calculations after all objects have been added to it.

For a detailed description of hatching enumeration, see the descriptions of the corresponding callback procedures MKI_HatchOpenPathProc, MKI_HatchAddObjectProc and MKI_HatchClosePathProc.