XInternAtoms

Syntax

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

Arguments

display	Specifies the connection to the X server.
names	Specifies the array of atom names.
count	Specifies the number of atom names in the array.
only_if_exists	Specifies a Boolean value that indicates whether the atom must be created.
atoms_return	Returns the atoms.

Description

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.

Diagnostics

BadAlloc	The server failed to allocate the requested source or server memory.
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.

See also

XFree(), XGetAtomName(), XGetWindowProperty(), XInternAtom(), "Properties and Atoms"

---

Christophe Tronche, [email protected]