XGetAtomName man page on BSDi

Man page or keyword search:  
man Server   6284 pages
apropos Keyword Search (all sections)
Output format
BSDi logo
[printable version]



XInternAtom(3X11)	 XLIB FUNCTIONS XInternAtom(3X11)

NAME
       XInternAtom, XInternAtoms, XGetAtomName, XGetAtomNames -
       create or return atom names

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

       Status XInternAtoms(display, names, count, only_if_exists,
       atoms_return)
	     Display *display;
	     char **names;
	     int count;
	     Bool only_if_exists;
	     Atom *atoms_return;

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

       Status XGetAtomNames(display, atoms, count, names_return)
	     Display *display;
	     Atom *atoms;
	     int count;
	     char **names_return;

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

       atoms	Specifies the array of atoms.

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

       atoms_return
		 Returns the atoms.

       count	Specifies the number of atom names in the array.

       count	Specifies the number of atoms in the array.

       display	Specifies the connection to the X server.

       names	Specifies the array of atom names.

       names_return
		 Returns the atom names.

       only_if_exists
		 Specifies a Boolean value that indicates whether
		 the atom must be created.

X Version 11		Release 6.4				1

XInternAtom(3X11)	 XLIB FUNCTIONS XInternAtom(3X11)

DESCRIPTION
       The XInternAtom function returns the atom identifier asso-
       ciated 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 Encod-
       ing, the result is implementation-dependent.  Uppercase
       and lowercase matter; 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 con-
       nection to the X server closes.

       XInternAtom can generate BadAlloc and BadValue errors.

       The XInternAtoms function returns the atom identifiers
       associated with the specified names.  The atoms are stored
       in the atoms_return array supplied by the caller.  Calling
       this function is equivalent to calling XInternAtom for
       each of the names in turn with the specified value of
       only_if_exists, but this function minimizes the number of
       round-trip protocol exchanges between the client and the X
       server.

       This function returns a nonzero status if atoms are
       returned for all of the names; otherwise, it returns zero.

       XInternAtoms can generate BadAlloc and BadValue errors.

       The XGetAtomName function returns the name associated with
       the specified atom.  If the data returned by the server is
       in the Latin Portable Character Encoding, then the
       returned string is in the Host Portable Character Encod-
       ing.  Otherwise, the result is implementation-dependent.
       To free the resulting string, call XFree.

       XGetAtomName can generate a BadAtom error.

       The XGetAtomNames function returns the names associated
       with the specified atoms.  The names are stored in the
       names_return array supplied by the caller.  Calling this
       function is equivalent to calling XGetAtomName for each of
       the atoms in turn, but this function minimizes the number
       of round-trip protocol exchanges between the client and
       the X server.

       This function returns a nonzero status if names are
       returned for all of the atoms; otherwise, it returns zero.

       XGetAtomNames can generate a BadAtom error.

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

X Version 11		Release 6.4				2

XInternAtom(3X11)	 XLIB FUNCTIONS XInternAtom(3X11)

       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 spe-
		 cific 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.

SEE ALSO
       XFree(3X11), XGetWindowProperty(3X11)
       Xlib - C Language X Interface

X Version 11		Release 6.4				3

[top]

List of man pages available for BSDi

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net