Error handling

Enumerations
enum	xkb_error_code {   XKB_ERROR_INVALID = -1 ,   XKB_SUCCESS = 0 ,   XKB_ERROR_UNSUPPORTED_MODIFIER_MASK = 60 ,   XKB_ERROR_UNSUPPORTED_STATE_MODE = 86 ,   XKB_ERROR_UNSUPPORTED_KEY_ITERATOR_FLAGS = 138 ,   XKB_ERROR_UNSUPPORTED_LAYOUT_OUT_OF_RANGE_POLICY = 214 ,   XKB_ERROR_UNSUPPORTED_LAYOUT_INDEX = 237 ,   XKB_ERROR_UNSUPPORTED_KEYMAP_FORMAT = 277 ,   XKB_ERROR_LAYOUT_COUNT_LIMIT_EXCEEDED = 366 ,   XKB_ERROR_UNSUPPORTED_A11Y_FLAGS = 371 ,   XKB_ERROR_UNEXPECTED_STATE_MODE = 399 ,   XKB_ERROR_ABI_INVALID_STRUCT_SIZE = 450 ,   XKB_ERROR_ALLOCATION_FAILURE = 550 ,   XKB_ERROR_UNSUPPORTED_EVENTS_FLAGS = 611 ,   XKB_ERROR_UNSUPPORTED_MACHINE_FLAGS = 755 ,   XKB_ERROR_UNSUPPORTED_KEYMAP_SERIALIZATION_FLAGS = 829 ,   XKB_ERROR_ABI_FORWARD_COMPAT = 876 ,   XKB_ERROR_UNSUPPORTED_MACHINE_BUILDER_FLAGS = 899 ,   XKB_ERROR_ABI_BACKWARD_COMPAT = 914 }

Detailed Description

Error-handling related features.

Enumeration Type Documentation

xkb_error_code

enum xkb_error_code

Error codes returned by the API.

The numeric values are stable identifiers that are also used in logging. See the Error index for the full list of logging codes.

About the numeric values

Codes are small positive integers assigned non-sequentially by design: it prevents callers from assuming adjacency implies relatedness.

See these guidelines for further details on the methodology.

The value -1 (XKB_ERROR_INVALID) is reserved for pre-1.14 functions and does not follow the above scheme.

Since

1.14.0

Enumerator
XKB_ERROR_INVALID	An unspecified error occurred. Reserved for pre-1.14 functions, which signal errors via -1 return values documented per-function. Since 1.14.0
XKB_SUCCESS	The operation completed successfully. Since 1.14.0
XKB_ERROR_UNSUPPORTED_MODIFIER_MASK	Unsupported modifier mask. The modifier mask does not represent valid modifiers. Since 1.14.0
XKB_ERROR_UNSUPPORTED_STATE_MODE	Unsupported xkb_state_mode value. Use the following to check if the linked libxkbcommon supports a given mode: xkb_feature_supported(XKB_FEATURE_ENUM_STATE_MODE, flag) Since 1.14.0
XKB_ERROR_UNSUPPORTED_KEY_ITERATOR_FLAGS	Unsupported xkb_keymap_key_iterator_flags value. Use the following to check if the linked libxkbcommon supports a given flag: xkb_feature_supported(XKB_FEATURE_ENUM_KEYMAP_KEY_ITERATOR_FLAGS, flag) Since 1.14.0
XKB_ERROR_UNSUPPORTED_LAYOUT_OUT_OF_RANGE_POLICY	The given layout out-of-range policy is not supported. Use the following to check if the linked libxkbcommon supports a given flag: xkb_feature_supported(XKB_FEATURE_ENUM_LAYOUT_OUT_OF_RANGE_POLICY, flag) Since 1.14.0
XKB_ERROR_UNSUPPORTED_LAYOUT_INDEX	Layout index is not supported. xkbcommon supports different layout index ranges, depending on the target keymap format: XKB_KEYMAP_FORMAT_TEXT_V1: 1..4 XKB_KEYMAP_FORMAT_TEXT_V2: 1..32 Since 1.14.0
XKB_ERROR_UNSUPPORTED_KEYMAP_FORMAT	Unsupported keymap format. See xkb_keymap_format for the list of valid values. Since 1.14.0
XKB_ERROR_LAYOUT_COUNT_LIMIT_EXCEEDED	Layout count limit exceeded for the corresponding keymap format. Since 1.14.0
XKB_ERROR_UNSUPPORTED_A11Y_FLAGS	Unsupported xkb_a11y_flags value. Use the following to check if the linked libxkbcommon supports a given flag: xkb_feature_supported(XKB_FEATURE_ENUM_A11Y_FLAGS, flag) Since 1.14.0
XKB_ERROR_UNEXPECTED_STATE_MODE	A xkb_state object has an unexpected xkb_state_mode Since 1.14.0
XKB_ERROR_ABI_INVALID_STRUCT_SIZE	ABI struct size check failed. The size field of a versioned structure does not match any known version of that structure. This typically indicates the caller failed to initialize the struct correctly, e.g. by omitting: .size = sizeof(struct xkb_foo) Since 1.14.0
XKB_ERROR_ALLOCATION_FAILURE	Cannot allocate memory. Since 1.14.0
XKB_ERROR_UNSUPPORTED_EVENTS_FLAGS	Unsupported xkb_events_flags value. Use the following to check if the linked libxkbcommon supports a given flag: xkb_feature_supported(XKB_FEATURE_ENUM_EVENTS_FLAGS, flag) Since 1.14.0
XKB_ERROR_UNSUPPORTED_MACHINE_FLAGS	Unsupported xkb_machine_flags value. Use the following to check if the linked libxkbcommon supports a given flag: xkb_feature_supported(XKB_FEATURE_ENUM_MACHINE_FLAGS, flag) Since 1.14.0
XKB_ERROR_UNSUPPORTED_KEYMAP_SERIALIZATION_FLAGS	Unsupported keymap serialization flags. See xkb_keymap_serialize_flags for the list of valid flags. Since 1.14.0
XKB_ERROR_ABI_FORWARD_COMPAT	ABI forward-compatibility check failed. The caller was compiled against a newer version of the library and is using fields unknown to this version. Since 1.14.0
XKB_ERROR_UNSUPPORTED_MACHINE_BUILDER_FLAGS	Unsupported xkb_machine_builder_flags value. Use the following to check if the linked libxkbcommon supports a given flag: xkb_feature_supported(XKB_FEATURE_ENUM_MACHINE_BUILDER_FLAGS, flag) Since 1.14.0
XKB_ERROR_ABI_BACKWARD_COMPAT	ABI backward-compatibility check failed. The caller was compiled against an older version of the library and is missing fields that are mandatory in this version. Since 1.14.0