C++ Syntax

MKI_RESULTVALUE

MKI_EnumerateChar(

MKI_CONST_FONTDEF_PTR f_pFont,

__int32 f_nCharIndex,

MKI_CONST_MATRIX_PTR f_pMatrix,

__int64 f_nEnumMode,

MKI_ENUMOBJECT_PROC f_fnCallBack,

void* f_pUserData );

Enumerates a single characters.

Parameters

Font

[MKI_CONST_FONTDEF_PTR] Font definition of the font that shall be used to enumerate the character.

CharIndex

[__int32] Number of the character to be enumerated. Valid range: 32 <= Value <= 255.

Matrix

[MKI_CONST_MATRIX_PTR] Matrix with which the character data shall be multiplied before enumeration.

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

Currently, character enumeration will only work with internal (MKI_FONTTYPE_INTERN) and TrueType (MKI_FONTTYPE_TRUETYPE) fonts. Device fonts (MKI_FONTTYPE_DEVICE) cannot be resolved into curves and thus cannot be enumerated.