Manual pages › X Window and screen libraries (3X)

XInternA(3X)

create or return atom names

From the original Amiga UNIX 2.1 manual. Some things it mentions may not be in this release.

NAME

XInternAtom, XGetAtomName - create or 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

atom Specifies the atom for the property name you want returned.

atom_name Specifies the name associated with the atom you
          want returned.

display   Specifies the connection to the XWIN server.

only_if_exists

Specifies a Boolean value that indicates whether XInternAtom creates the atom.

DESCRIPTION

The XInternAtom function returns the atom identifier associated with the specified atom_name string. If only_if_exists is False, the atom is created if it does not exist. Therefore, XInternAtom can return None. You should use a null-terminated ISO Latin-1 string for atom_name. Case matters; the strings thing, Thing, and thinG all designate different atoms. The atom will remain defined even after the client's connection closes. It will become undefined only when the last connection to the XWIN server closes.

XInternAtom can generate BadAlloc and BadValue errors.

The XGetAtomName function returns the name associated with
the specified atom.  To free the resulting string, call
XFree.

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.

XWIN 3.0               Last change: 9/1/88                 .ie t

     BadValue  Some numeric value falls outside the range of