xkb_keymap_serialize_result Struct Reference

#include <xkbcommon.h>

Data Fields
size_t	size
char *	serialized
size_t	length
xkb_layout_mask_t	layouts

Private Attributes
uint32_t	reserved

Detailed Description

Result of xkb_keymap::xkb_keymap_serialize().

See also

xkb_keymap_serialize_config

Since

1.14.0

Field Documentation

size

size_t xkb_keymap_serialize_result::size

Size of this structure, for forward-compatibility.

See also

XKB_ERROR_ABI_INVALID_STRUCT_SIZE

XKB_ERROR_ABI_BACKWARD_COMPAT

XKB_ERROR_ABI_FORWARD_COMPAT

Since

1.14.0

serialized

char* xkb_keymap_serialize_result::serialized

A newly allocated keymap serialization, or NULL on failure.

The caller of xkb_keymap::xkb_keymap_serialize() must free it.

Since

1.14.0

length

size_t xkb_keymap_serialize_result::length

Length of serialized, in bytes, including any terminating NUL byte.

Valid only if the function returns XKB_SUCCESS; otherwise unspecified.

Since

1.14.0

layouts

xkb_layout_mask_t xkb_keymap_serialize_result::layouts

Mask of the original layouts actually included in serialized.

Valid only if the function returns XKB_SUCCESS; otherwise unspecified.

See also

xkb_keymap_serialize_config::layouts

Since

1.14.0

reserved

uint32_t xkb_keymap_serialize_result::reserved

private

Reserved for future extensions.

Precondition

Must be set to 0 by the caller.

---

The documentation for this struct was generated from the following file:

• include/xkbcommon/xkbcommon.h