Get the Unicode/UTF-8 string obtained from pressing a particular key
in a given keyboard state.
@paramin state The keyboard state object.
@paramin key The keycode of the key.
@paramout buffer A buffer to write the string into.
@paramin size Size of the buffer.
@warning If the buffer passed is too small, the string is truncated
(though still NUL-terminated).
@returns The number of bytes required for the string, excluding the
NUL byte. If there is nothing to write, returns 0.
You may check if truncation has occurred by comparing the return value
with the size of @p buffer, similarly to the snprintf(3) function.
You may safely pass NULL and 0 to @p buffer and @p size to find the
required size (without the NUL-byte).
This function performs Capitalization and Control @ref
keysym-transformations.
Get the Unicode/UTF-8 string obtained from pressing a particular key in a given keyboard state.
@paramin state The keyboard state object. @paramin key The keycode of the key. @paramout buffer A buffer to write the string into. @paramin size Size of the buffer.
@warning If the buffer passed is too small, the string is truncated (though still NUL-terminated).
@returns The number of bytes required for the string, excluding the NUL byte. If there is nothing to write, returns 0.
You may check if truncation has occurred by comparing the return value with the size of @p buffer, similarly to the snprintf(3) function. You may safely pass NULL and 0 to @p buffer and @p size to find the required size (without the NUL-byte).
This function performs Capitalization and Control @ref keysym-transformations.
@memberof xkb_state @since 0.4.1