XInternAtom(3X) — X Version 11

NAME

XInternAtom, XGetAtomName − create and return atom names

SYNTAX

Atom XInternAtom(display, atom_name, only_if_exists)
      Display ∗display;
      char ∗atom_name;
      Bool only_if_exists;

char ∗XGetAtomName(display, atom)
Display ∗display;
Atom atom;

ARGUMENTS

atomSpecifies the atom associated with the string name you want returned.

atom_nameSpecifies the name associated with the atom you want returned.

displaySpecifies the connection to the X server.

only_if_exists
Specifies a boolean value that indicates whether XInternAtom creates the atom. You can pass either True or False.

DESCRIPTION

The XInternAtom function returns the atom identifier associated with the string you passed to the atom_name argument. .PN XInternAtom can generate BadAlloc and BadValue errors.

The XGetAtomName function returns the name associated with the atom identifier you passed to the atom argument. You previously obtained the atom identifier by calling XInternAtom. .PN XGetAtomName can generate a BadAtom error.

DIAGNOSTICS

BadAlloc The server failed to allocate the requested resource or server memory.

BadAtom A value for an Atom argument does not name a defined Atom.

BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument’s type is accepted. Any argument defined as a set of alternatives can generate this error.

Museum