XkbOpenDisplay(3)

okay so bestie, welcome to XkbOpenDisplay(3) from the XKB FUNCTIONS manual — section 3, we been knew 💅. this one is literally a convenience function doing three whole things at once, so grab a strawberry 🍓 and let's get into it.

✨ NAME ✨

XkbOpenDisplay — checks for a compatible version of the Xkb extension in both the library and the server, and initializes the extension for use. yes, she does all that 💖.

🦋 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 — the hardware display name, which determines the display and communications domain to be used. it's giving “where am I connecting and who am I talking to” energy 🌸.
• event_rtrn — gets backfilled with the extension base event code. cute little output slot ✨.
• error_rtrn — gets backfilled with the extension base error code. also an output slot, but make it error-core 💀.
• major_in_out — compile time lib major version in, server major version out. she's a two-way street 🫶.
• minor_in_out — compile time lib min version in, server minor version out. same deal, smaller number, still iconic 🎀.
• reason_rtrn — gets backfilled with a status code. this is the “what happened, bestie?” report 💅.

💖 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. three tasks, one function, main character energy 👑.

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. no cap, she always tells you what's up 🌈.

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. okay so that's the vibe check failing at the library stage 💀.

if the library is compatible, XkbOpenDisplay next calls XOpenDisplay with the display_name. if this fails, the function returns NULL. connection refused? not today, bestie 😭.

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. slay 💅✨.

the possible values for reason_rtrn are:

• XkbOD_BadLibraryVersion indicates XkbLibraryVersion returned False. library said no 💀.
• XkbOD_ConnectionRefused indicates the display could not be opened. the connection is not connecting 🙈.
• XkbOD_BadServerVersion indicates the library and the server have incompatible extension versions. they're not matching each other's freak 😭.
• XkbOD_NonXkbServer indicates the extension is not present in the X server. no Xkb in this server, bestie 🫠.
• XkbOD_Success indicates that the function succeeded. ate and left no crumbs 👑🔥.

🌸 RETURN VALUES 🌸

• NULL — the XkbOpenDisplay function returns NULL if the library is incompatible. it also returns NULL if the call to XOpenDisplay with the display_name fails. and it 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. three ways to catch a NULL, all valid 💀💖.

⭐ DIAGNOSTICS ⭐

• BadAccess — the Xkb extension has not been properly initialized. bestie, she is not ready yet 🚨.

🦋 SEE ALSO 🦋

XkbLibraryVersion(3), XkbQueryExtension(3), XOpenDisplay(3)

---

that's the whole page, bestie 🫶 — brought to you by X Version 11, libX11 1.8.14, and the XkbOpenDisplay(3) footer. mwah 💋🎀