XkbGetKeyBehaviors (3)

Leading comments

Copyright 1999 Oracle and/or its affiliates. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following condition...

(The comments found at the beginning of the groff file "man3/XkbGetKeyBehaviors.3".)

NAME

XkbGetKeyBehaviors - Obtain the behaviors (the behaviors array) for a subset of the keys in a keyboard description from the server

SYNOPSIS

Status XkbGetKeyBehaviors (Display *dpy, unsigned int first, unsigned int num, XkbDescPtr xkb);
     

ARGUMENTS

- dpy

connection to server

- first

keycode of first key to get

- num

number of keys for which behaviors are desired

- xkb

Xkb description to contain the result

DESCRIPTION

XkbGetKeyBehaviors sends a request to the server to obtain the behaviors for num keys on the keyboard starting with the key whose keycode is first. It waits for a reply and returns the behaviors in the server->behaviors field of xkb. If successful, XkbGetKeyBehaviors returns Success.
If the server map in the xkb parameter has not been allocated, XkbGetKeyBehaviors allocates and initializes it before obtaining the actions.
If the server does not have a compatible version of Xkb, or the Xkb extension has not been properly initialized, XkbGetKeyBehaviors returns BadAccess. If num is less than 1 or greater than XkbMaxKeyCount, XkbGetKeyBehaviors returns BadValue. If any allocation errors occur, XkbGetKeyBehaviors returns BadAlloc.

DIAGNOSTICS

BadAccess

The Xkb extension has not been properly initialized

BadAlloc

Unable to allocate storage

BadValue

An argument is out of range