MKI_PROFILE_* (Profile and Collection Result) Changed in Version 2025.1

Combined result and warnings from a profile or collection function.

If the lowest 8 bits (MKI_PROFILE_RESULT_MASK) are zero, the operation was basically successful. Additional bits may however be set to indicate warnings (MKI_PROFILE_WARNING_MASK). It is on you to decide whether the overall operation was successful for your specific context.

Use the mki_ok macro to check for a successful output (the lowest 8 bits are zero):

#define mki_ok( p ) ( ( ( p ) & MKI_PROFILE_RESULT_MASK ) == MKI_PROFILE_RESULT_OK )

Result

The result is encoded in the lowest 8 bits (MKI_PROFILE_RESULT_MASK) of the value:

MKI_PROFILE_RESULT_OK (0)

No error.

MKI_PROFILE_RESULT_ERROR_READING (1)

General error while reading an item.

MKI_PROFILE_RESULT_ERROR_WRITING (2)

General error while writing an item.

MKI_PROFILE_RESULT_ITEM_NOT_FOUND (3)

The stated item could not be found.

MKI_PROFILE_RESULT_ITEM_INVALID (4)

The item was found, but did not contain the expected data elements.

MKI_PROFILE_RESULT_OUT_OF_MEMORY (5)

Out of memory while trying to allocate memory to store the item.

MKI_PROFILE_RESULT_UNKNOWN_VERSION (6)

The item uses an unknown version, probably created by a newer version than the current application.

MKI_PROFILE_RESULT_UNAVAILABLE (7)

Access to collections is not granted by the serving application.

Warnings

Warnings are encoded in the upper 24 bits (MKI_PROFILE_WARNING_MASK) of the value:

MKI_PROFILE_WARNING_LAYER_NOT_FOUND (0x00000100)

At least one referenced layer name was not found.

MKI_PROFILE_WARNING_PEN_NOT_FOUND (0x00000200)

At least one referenced pen name was not found.

MKI_PROFILE_WARNING_LINE_NOT_FOUND (0x00000400)

At least one referenced line type name was not found.

MKI_PROFILE_WARNING_SYSTEM_NOT_FOUND (0x00000800)

At least one referenced coordinate system name was not found.

MKI_PROFILE_WARNING_EXTENDED_NOT_FOUND (0x00001000)

At least one referenced extended object type was not found.

MKI_PROFILE_WARNING_COLOR_NOT_FOUND (0x00002000)

At least one referenced color name was not found.