XInternAtom(3X)                                   XInternAtom(3X)



NAME
     XInternAtom, XGetAtomName - create and return atom names

SYNOPSIS
     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;

DESCRIPTION
     The XInternAtom function returns the atom identifier associ-
     ated with atom-name.  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
     remains defined even after the client's connection closes.
     It becomes undefined only when the last connection to the X
     server closes.

     The XGetAtomName function returns the name associated with
     atom, as obtained by calling XInternAtom.  To free the
     resulting string, call XFree.

   Arguments
     These functions accept the following arguments:

     atom    Specifies the atom associated with the string name
             to be returned.

     atom-name
             Specifies the name associated with the atom to be
             returned.

     display Specifies the connection to the X server.

     only-if-exists
             Specifies a Boolean value that indicates whether or
             not
             XInternAtom creates the atom.  You can pass either
             TRUE or FALSE.

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

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



November, 1990                                                  1

XInternAtom(3X)                                   XInternAtom(3X)



             atom.

     BadValue
             A numeric value falls outside the range of values
             accepted by the request.  Unless a range is speci-
             fied 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.

     The XInternAtom function can generate BadAlloc and
     BadValue errors.

     The XGetAtomName function can generate a BadAtom error.

SEE ALSO
     XFree(3X), XGetWindowProperty(3X)

     Xlib - C Language Interface






































2                                                  November, 1990