<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<!-- lifted from troff+man by doclifter -->
<refentry id='xstcolorsman'>
<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium -->

<!--  Permission is hereby granted, free of charge, to any person obtaining -->
<!--  a copy of this software and associated documentation files (the -->
<!--  "Software"), to deal in the Software without restriction, including -->
<!--  without limitation the rights to use, copy, modify, merge, publish, -->
<!--  distribute, sublicense, and/or sell copies of the Software, and to -->
<!--  permit persons to whom the Software is furnished to do so, subject to -->
<!--  the following conditions: -->

<!--  The above copyright notice and this permission notice shall be included -->
<!--  in all copies or substantial portions of the Software. -->

<!--  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS -->
<!--  OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -->
<!--  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -->
<!--  IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR -->
<!--  OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, -->
<!--  ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -->
<!--  OTHER DEALINGS IN THE SOFTWARE. -->

<!--  Except as contained in this notice, the name of the X Consortium shall -->
<!--  not be used in advertising or otherwise to promote the sale, use or -->
<!--  other dealings in this Software without prior written authorization -->
<!--  from the X Consortium. -->

<!--  Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by -->
<!--  Digital Equipment Corporation -->

<!--  Portions Copyright \(co 1990, 1991 by -->
<!--  Tektronix, Inc. -->

<!--  Permission to use, copy, modify and distribute this documentation for -->
<!--  any purpose and without fee is hereby granted, provided that the above -->
<!--  copyright notice appears in all copies and that both that copyright notice -->
<!--  and this permission notice appear in all copies, and that the names of -->
<!--  Digital and Tektronix not be used in in advertising or publicity pertaining -->
<!--  to this documentation without specific, written prior permission. -->
<!--  Digital and Tektronix makes no representations about the suitability -->
<!--  of this documentation for any purpose. -->
<!--  It is provided ``as is'' without express or implied warranty. -->
<!--   -->
<!--  $XFree86: xc/doc/man/X11/XStColors.man,v 1.3 2003/04/28 22:17:57 herrb Exp $ -->

<!-- .na -->
<!-- Ds listing suppressed (not used) -->
<!-- De listing suppressed (not used) -->
<!-- FD listing suppressed (not used) -->
<!-- FN listing suppressed (not used) -->
<!-- IN listing suppressed (not used) -->
<!-- C{ listing suppressed (not used) -->
<!-- C} listing suppressed (not used) -->
<!-- Pn listing suppressed (not used) -->
<!-- hN listing suppressed (not used) -->
<!-- NT listing suppressed (not used) -->
<!-- .		\" Note End \-\- doug kraft 3/85 -->
<!-- NE listing suppressed (not used) -->
<!-- .ny0 -->
<refmeta>
<refentrytitle>XStoreColors</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XStoreColors</refname>
<refname>XStoreColor</refname>
<refname>XStoreNamedColor</refname>
<refpurpose>set colors</refpurpose>
</refnamediv>
<!-- body begins here -->

<refsect1 id='syntax'><title>SYNTAX</title>

<para>int XStoreColors&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Colormap <emphasis remap='I'>colormap</emphasis>&hairsp;,
XColor <emphasis remap='I'>color</emphasis>&hairsp;[&hairsp;]&hairsp;, int <emphasis remap='I'>ncolors</emphasis>&hairsp;);</para> 

<para>int XStoreColor&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Colormap <emphasis remap='I'>colormap</emphasis>&hairsp;,
XColor *<emphasis remap='I'>color</emphasis>&hairsp;);</para> 

<para>int XStoreNamedColor&hairsp;(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, Colormap <emphasis remap='I'>colormap</emphasis>&hairsp;,
char *&hairsp;<emphasis remap='I'>color</emphasis>&hairsp;, unsigned long <emphasis remap='I'>pixel</emphasis>&hairsp;, int <emphasis remap='I'>flags</emphasis>&hairsp;);</para>
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>color</emphasis></term>
  <listitem>
<para>Specifies the pixel and RGB values or the color name string (for example, red).</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>color</emphasis></term>
  <listitem>
<para>Specifies an array of color definition structures to be stored.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>colormap</emphasis></term>
  <listitem>
<para>Specifies the colormap.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>display</emphasis></term>
  <listitem>
<para>Specifies the connection to the X server.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>flags</emphasis></term>
  <listitem>
<para>Specifies which red, green, and blue components are set.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>ncolors</emphasis></term>
  <listitem>
<!-- Specifies the number of color definition structures.  -->
<para>Specifies the number of 
<emphasis remap='I'>&hairsp;XColor&hairsp;</emphasis>
structures in the color definition array.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>pixel</emphasis></term>
  <listitem>
<para>Specifies the entry in the colormap.</para> 
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>The
<emphasis remap='I'>&hairsp;XStoreColors&hairsp;</emphasis>
function changes the colormap entries of the pixel values
specified in the pixel members of the
<emphasis remap='I'>&hairsp;XColor&hairsp;</emphasis>
structures.
You specify which color components are to be changed by setting 
<emphasis remap='I'>&hairsp;DoRed&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;DoGreen&hairsp;</emphasis>,
and/or
<emphasis remap='I'>&hairsp;DoBlue&hairsp;</emphasis>
in the flags member of the
<emphasis remap='I'>&hairsp;XColor&hairsp;</emphasis>
structures.
If the colormap is an installed map for its screen, the
changes are visible immediately.
<emphasis remap='I'>&hairsp;XStoreColors&hairsp;</emphasis>
changes the specified pixels if they are allocated writable in the colormap 
by any client, even if one or more pixels generates an error.
If a specified pixel is not a valid index into the colormap, a
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
error results.
If a specified pixel either is unallocated or is allocated read-only, a
<emphasis remap='I'>&hairsp;BadAccess&hairsp;</emphasis>
error results.
If more than one pixel is in error, 
the one that gets reported is arbitrary.</para>

<para><emphasis remap='I'>&hairsp;XStoreColors&hairsp;</emphasis>
can generate
<emphasis remap='I'>&hairsp;BadAccess&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;BadColor&hairsp;</emphasis>,
and
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
errors.</para>

<para>The
<emphasis remap='I'>&hairsp;XStoreColor&hairsp;</emphasis>
function changes the colormap entry of the pixel value specified in the
pixel member of the
<emphasis remap='I'>&hairsp;XColor&hairsp;</emphasis>
structure.
You specified this value in the
pixel member of the
<emphasis remap='I'>&hairsp;XColor&hairsp;</emphasis>
structure.
This pixel value must be a read/write cell and a valid index into the colormap.
If a specified pixel is not a valid index into the colormap,
a
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
error results.
<emphasis remap='I'>&hairsp;XStoreColor&hairsp;</emphasis>
also changes the red, green, and/or blue color components.
You specify which color components are to be changed by setting
<emphasis remap='I'>&hairsp;DoRed&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;DoGreen&hairsp;</emphasis>,
and/or
<emphasis remap='I'>&hairsp;DoBlue&hairsp;</emphasis>
in the flags member of the
<emphasis remap='I'>&hairsp;XColor&hairsp;</emphasis>
structure.
If the colormap is an installed map for its screen, 
the changes are visible immediately.</para>

<para><emphasis remap='I'>&hairsp;XStoreColor&hairsp;</emphasis>
can generate
<emphasis remap='I'>&hairsp;BadAccess&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;BadColor&hairsp;</emphasis>,
and 
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
errors.</para>

<para>The
<emphasis remap='I'>&hairsp;XStoreNamedColor&hairsp;</emphasis>
function looks up the named color with respect to the screen associated with
the colormap and stores the result in the specified colormap.
The pixel argument determines the entry in the colormap.
The flags argument determines which of the red, green, and blue components 
are set. 
You can set this member to the
bitwise inclusive OR of the bits 
<emphasis remap='I'>&hairsp;DoRed&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;DoGreen&hairsp;</emphasis>,
and 
<emphasis remap='I'>&hairsp;DoBlue&hairsp;</emphasis>.
If the color name is not in the Host Portable Character Encoding, 
the result is implementation-dependent.
Use of uppercase or lowercase does not matter.
If the specified pixel is not a valid index into the colormap, a
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
error results.
If the specified pixel either is unallocated or is allocated read-only, a
<emphasis remap='I'>&hairsp;BadAccess&hairsp;</emphasis>
error results.</para>

<para><emphasis remap='I'>&hairsp;XStoreNamedColor&hairsp;</emphasis>
can generate
<emphasis remap='I'>&hairsp;BadAccess&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;BadColor&hairsp;</emphasis>,
<emphasis remap='I'>&hairsp;BadName&hairsp;</emphasis>,
and
<emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis>
errors.</para>
</refsect1>

<refsect1 id='diagnostics'><title>DIAGNOSTICS</title>
<variablelist remap='TP'>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadAccess&hairsp;</emphasis></term>
  <listitem>
<para>A client attempted
to free a color map entry that it did not already allocate.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadAccess&hairsp;</emphasis></term>
  <listitem>
<para>A client attempted
to store into a read-only color map entry.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadColor&hairsp;</emphasis></term>
  <listitem>
<para>A value for a Colormap argument does not name a defined Colormap.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadName&hairsp;</emphasis></term>
  <listitem>
<para>A font or color of the specified name does not exist.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>&hairsp;BadValue&hairsp;</emphasis></term>
  <listitem>
<para>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.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para>XAllocColor(3X11),
XCreateColormap(3X11),
XQueryColor(3X11)
<!-- .br -->
<userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

