XkbGetNames - Obtain symbolic names from the server

NAME SYNOPSIS ARGUMENTS DESCRIPTION DIAGNOSTICS SEE ALSO

NAME

XkbGetNames − Obtain symbolic names from the server

SYNOPSIS

Status XkbGetNames

(Display *dpy, unsigned int which, XkbDescPtr xkb);

ARGUMENTS

	*dpy*		connection to the X server
	which		mask of names or map components to be updated
	xkb		keyboard description to be updated

XkbGetNames retrieves symbolic names for the components of the keyboard extension from the X server. The which parameter specifies the name components to be updated in the xkb parameter, and is the bitwise inclusive OR of the valid names mask bits defined in Table 1.

If the names field of the keyboard description xkb is NULL, XkbGetNames allocates and initializes the names component of the keyboard description before obtaining the values specified by which. If the names field of xkb is not NULL, XkbGetNames obtains the values specified by which and copies them into the keyboard description Xkb.

If the map component of the xkb parameter is NULL, XkbGetNames does not retrieve type or shift level names, even if XkbKeyTypeNamesMask or XkbKTLevelNamesMask are set in which.

XkbGetNames can return Success, or BadAlloc, BadLength, BadMatch, and BadImplementation errors.

To free symbolic names, use XkbFreeNames.

DIAGNOSTICS

BadAlloc

Unable to allocate storage

BadImplementation

Invalid reply from server

	BadLength		The length of a request is shorter or longer than that required to minimally contain the arguments
	BadMatch		A compatible version of Xkb was not available in the server or an argument has correct type and range, but is otherwise invalid