<?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='xscontextman'>
<!--  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/XSContext.man,v 1.3 2003/04/28 22:17:56 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>XSaveContext</refentrytitle>
<manvolnum>3X11</manvolnum>
<refmiscinfo class='date'>__xorgversion__</refmiscinfo>
<refmiscinfo class='source'>XLIB FUNCTIONS</refmiscinfo>
</refmeta>
<refnamediv id='name'>
<refname>XSaveContext</refname>
<refname>XFindContext</refname>
<refname>XDeleteContext</refname>
<refname>XUniqueContext</refname>
<refpurpose>associative look-up routines</refpurpose>
</refnamediv>
<!-- body begins here -->

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

<para>int XSaveContext(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, XID <emphasis remap='I'>rid</emphasis>&hairsp;, XContext
<emphasis remap='I'>context</emphasis>&hairsp;, XPointer <emphasis remap='I'>data</emphasis>&hairsp;);</para> 

<para>int XFindContext(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, XID <emphasis remap='I'>rid</emphasis>&hairsp;, XContext
<emphasis remap='I'>context</emphasis>&hairsp;, XPointer *<emphasis remap='I'>data_return</emphasis>&hairsp;);</para> 

<para>int XDeleteContext(&hairsp;Display *<emphasis remap='I'>display</emphasis>&hairsp;, XID <emphasis remap='I'>rid</emphasis>, XContext
<emphasis remap='I'>context</emphasis>);</para> 

<para>XContext XUniqueContext(void);</para> 
</refsect1>

<refsect1 id='arguments'><title>ARGUMENTS</title>
<variablelist remap='IP'>
  <varlistentry>
  <term><emphasis remap='I'>context</emphasis></term>
  <listitem>
<para>Specifies the context type to which the data belongs.</para> 
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>data</emphasis></term>
  <listitem>
<para>Specifies the data to be associated with the window and type.</para>
  </listitem>
  </varlistentry>
  <varlistentry>
  <term><emphasis remap='I'>data_return</emphasis></term>
  <listitem>
<para>Returns the data.</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'>rid</emphasis></term>
  <listitem>
<para>Specifies the resource ID with which the data is associated.</para>
  </listitem>
  </varlistentry>
</variablelist>
</refsect1>

<refsect1 id='description'><title>DESCRIPTION</title>
<para>If an entry with the specified resource ID and type already exists,
<emphasis remap='I'>&hairsp;XSaveContext&hairsp;</emphasis>
overrides it with the specified context.
The
<emphasis remap='I'>&hairsp;XSaveContext&hairsp;</emphasis>
function returns a nonzero error code if an error has occurred
and zero otherwise.
Possible errors are
<emphasis remap='I'>&hairsp;XCNOMEM&hairsp;</emphasis>
(out of memory).</para>

<para>Because it is a return value,
the data is a pointer.
The
<emphasis remap='I'>&hairsp;XFindContext&hairsp;</emphasis>
function returns a nonzero error code if an error has occurred
and zero otherwise.
Possible errors are
<emphasis remap='I'>&hairsp;XCNOENT&hairsp;</emphasis>
(context-not-found).</para>

<para>The
<emphasis remap='I'>&hairsp;XDeleteContext&hairsp;</emphasis>
function deletes the entry for the given resource ID 
and type from the data structure.
This function returns the same error codes that
<emphasis remap='I'>&hairsp;XFindContext&hairsp;</emphasis>
returns if called with the same arguments.
<emphasis remap='I'>&hairsp;XDeleteContext&hairsp;</emphasis>
does not free the data whose address was saved.</para>

<para>The
<emphasis remap='I'>&hairsp;XUniqueContext&hairsp;</emphasis>
function creates a unique context type that may be used in subsequent calls to
<emphasis remap='I'>&hairsp;XSaveContext&hairsp;</emphasis>.</para>
</refsect1>

<refsect1 id='see_also'><title>SEE ALSO</title>
<para><userinput>Xlib - C Language X Interface</userinput></para>
</refsect1>
</refentry>

