Query: xinternatom
OS: hpux
Section: 3x
Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar
XInternAtom(3X) XLIB FUNCTIONS XInternAtom(3X)NAMEXInternAtom - returns atom identifierSYNTAXAtom XInternAtom(display, atom_name, only_if_exists) Display *display; char *atom_name; Bool only_if_exists;ARGUMENTSdisplay Specifies the connection to the X server. atom_name Specifies the name associated with the atom you want returned. only_if_exists Specifies a Boolean value that indicates whether the atom must be created.DESCRIPTIONThe 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. If the atom name is not in the Host Portable Character Encoding, the result is implementation dependent. Uppercase and lowercase matter; the strings ``thing'', ``Thing'', and ``thinG'' all designate dif- ferent atoms. The atom will remain defined even after the client's connection closes. It will become undefined only when the last connec- tion to the X server closes. XInternAtom can generate BadAlloc and BadValue errors.DIAGNOSTICSBadAlloc 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 argu- ment, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error.SEE ALSOXInternAtoms(3X), XGetAtomName(3X), XGetAtomNames(3X) X Version 11 Release 6 XInternAtom(3X)