Copyright (c) 1999, Oracle and/or its affiliates.

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 conditions:

The above copyright notice and this permission notice (including the next
paragraph) shall be included in all copies or substantial portions of the
Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

XkbOpenDisplay __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
NAME
XkbOpenDisplay - Checks for a compatible version of the Xkb extension in both the library and the server, and initializes the extension for use.
SYNOPSIS

Display *XkbOpenDisplay "(\^_Xconst char *" "display_name" "\^," "int *" "event_rtrn" "\^," "int *" "error_rtrn" "\^," "int *" "major_in_out" "\^," "int *" "minor_in_out" "\^," "int *" "reason_rtrn" "\^);"

ARGUMENTS

display_name hardware display name, which determines the display and communications domain to be used

event_rtrn backfilled with the extension base event code

error_rtrn backfilled with the extension base error code

major_in_out compile time lib major version in, server major version out

minor_in_out compile time lib min version in, server minor version out

reason_rtrn backfilled with a status code

DESCRIPTION

As a convenience, you can use the function XkbOpenDisplay to perform these three tasks at once: open a connection to an X server, check for a compatible version of the Xkb extension in both the library and the server, and initialize the extension for use. XkbOpenDisplay is a convenience function that opens an X display connection and initializes the X keyboard extension. In all cases, upon return reason_rtrn contains a status value indicating success or the type of failure. If major_in_out and minor_in_out are not NULL, XkbOpenDisplay first calls XkbLibraryVersion to determine whether the client library is compatible, passing it the values pointed to by major_in_out and minor_in_out. If the library is incompatible, XkbOpenDisplay backfills major_in_out and minor_in_out with the major and minor extension versions of the library being used and returns NULL. If the library is compatible, XkbOpenDisplay next calls XOpenDisplay with the display_name. If this fails, the function returns NULL. If successful, XkbOpenDisplay calls XkbQueryExtension and backfills the major and minor Xkb server extension version numbers in major_in_out and minor_in_out. If the server extension version is not compatible with the library extension version or if the server extension is not present, XkbOpenDisplay closes the display and returns NULL. When successful, the function returns the display connection. The possible values for reason_rtrn are:

\(bu 5
XkbOD_BadLibraryVersion indicates XkbLibraryVersion returned False.
\(bu 5
XkbOD_ConnectionRefused indicates the display could not be opened.
\(bu 5
XkbOD_BadServerVersion indicates the library and the server have incompatible extension versions.
\(bu 5
XkbOD_NonXkbServer indicates the extension is not present in the X server.
\(bu 5
XkbOD_Success indicates that the function succeeded.
"RETURN VALUES"

15 NULL The XkbOpenDisplay function returns NULL if the library is incompatible. The XkbOpenDisplay function returns NULL if the call to XOpenDisplay with the display_name fails. The XkbOpenDisplay function returns NULL and closes the display if the server extension version is not compatible with the library extension version or if the server extension is not present.

DIAGNOSTICS

15 BadAccess The Xkb extension has not been properly initialized

"SEE ALSO"
XkbLibraryVersion (__libmansuffix__), XkbQueryExtension (__libmansuffix__), XOpenDisplay (__libmansuffix__)