1. NAME

XkbGetKeyTypes - Obtain the list of available key types in the server's keyboard mapping

2. SYNOPSIS

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

3. ARGUMENTS

  • - dpy
        connection to X server
  • - first
        index to first type to get, 0 => 1st type
  • - num
        number of key types to be returned
  • - xkb
        keyboard description containing client map to update

4. DESCRIPTION

XkbGetKeyTypesqueries the server for the desired types, waits for a reply, and returns the desired types in the xkb->map->types.If successful, it returns Success. XkbGetKeyTypesreturns BadAccess if the Xkb extension has not been properly initialized and BadValue if the combination of firstand numresults in numbers out of valid range.

NOTE: XkbGetKeyTypesis used to obtain descriptions of the key types themselves, not the key types bound to individual keys. To obtain the key types bound to an individual key, refer to the key_sym_mapfield of the client map.

5. DIAGNOSTICS

BadAccess

               The Xkb extension has not been properly initialized

BadValue

               An argument is out of range

6. SEE ALSO

R XkbKeyType (3),

R XkbKeyTypeIndex (3)