Blame man/XCreateOC.man

Packit Service dc579d
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
Packit Service dc579d
.\"
Packit Service dc579d
.\" Permission is hereby granted, free of charge, to any person obtaining
Packit Service dc579d
.\" a copy of this software and associated documentation files (the
Packit Service dc579d
.\" "Software"), to deal in the Software without restriction, including
Packit Service dc579d
.\" without limitation the rights to use, copy, modify, merge, publish,
Packit Service dc579d
.\" distribute, sublicense, and/or sell copies of the Software, and to
Packit Service dc579d
.\" permit persons to whom the Software is furnished to do so, subject to
Packit Service dc579d
.\" the following conditions:
Packit Service dc579d
.\"
Packit Service dc579d
.\" The above copyright notice and this permission notice shall be included
Packit Service dc579d
.\" in all copies or substantial portions of the Software.
Packit Service dc579d
.\"
Packit Service dc579d
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
Packit Service dc579d
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Packit Service dc579d
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Packit Service dc579d
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
Packit Service dc579d
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Packit Service dc579d
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Packit Service dc579d
.\" OTHER DEALINGS IN THE SOFTWARE.
Packit Service dc579d
.\"
Packit Service dc579d
.\" Except as contained in this notice, the name of the X Consortium shall
Packit Service dc579d
.\" not be used in advertising or otherwise to promote the sale, use or
Packit Service dc579d
.\" other dealings in this Software without prior written authorization
Packit Service dc579d
.\" from the X Consortium.
Packit Service dc579d
.\"
Packit Service dc579d
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
Packit Service dc579d
.\" Digital Equipment Corporation
Packit Service dc579d
.\"
Packit Service dc579d
.\" Portions Copyright \(co 1990, 1991 by
Packit Service dc579d
.\" Tektronix, Inc.
Packit Service dc579d
.\"
Packit Service dc579d
.\" Permission to use, copy, modify and distribute this documentation for
Packit Service dc579d
.\" any purpose and without fee is hereby granted, provided that the above
Packit Service dc579d
.\" copyright notice appears in all copies and that both that copyright notice
Packit Service dc579d
.\" and this permission notice appear in all copies, and that the names of
Packit Service dc579d
.\" Digital and Tektronix not be used in in advertising or publicity pertaining
Packit Service dc579d
.\" to this documentation without specific, written prior permission.
Packit Service dc579d
.\" Digital and Tektronix makes no representations about the suitability
Packit Service dc579d
.\" of this documentation for any purpose.
Packit Service dc579d
.\" It is provided ``as is'' without express or implied warranty.
Packit Service dc579d
.\" 
Packit Service dc579d
.\"
Packit Service dc579d
.ds xT X Toolkit Intrinsics \- C Language Interface
Packit Service dc579d
.ds xW Athena X Widgets \- C Language X Toolkit Interface
Packit Service dc579d
.ds xL Xlib \- C Language X Interface
Packit Service dc579d
.ds xC Inter-Client Communication Conventions Manual
Packit Service dc579d
.na
Packit Service dc579d
.de Ds
Packit Service dc579d
.nf
Packit Service dc579d
.\\$1D \\$2 \\$1
Packit Service dc579d
.ft CW
Packit Service dc579d
.\".ps \\n(PS
Packit Service dc579d
.\".if \\n(VS>=40 .vs \\n(VSu
Packit Service dc579d
.\".if \\n(VS<=39 .vs \\n(VSp
Packit Service dc579d
..
Packit Service dc579d
.de De
Packit Service dc579d
.ce 0
Packit Service dc579d
.if \\n(BD .DF
Packit Service dc579d
.nr BD 0
Packit Service dc579d
.in \\n(OIu
Packit Service dc579d
.if \\n(TM .ls 2
Packit Service dc579d
.sp \\n(DDu
Packit Service dc579d
.fi
Packit Service dc579d
..
Packit Service dc579d
.de IN		\" send an index entry to the stderr
Packit Service dc579d
..
Packit Service dc579d
.de Pn
Packit Service dc579d
.ie t \\$1\fB\^\\$2\^\fR\\$3
Packit Service dc579d
.el \\$1\fI\^\\$2\^\fP\\$3
Packit Service dc579d
..
Packit Service dc579d
.de ZN
Packit Service dc579d
.ie t \fB\^\\$1\^\fR\\$2
Packit Service dc579d
.el \fI\^\\$1\^\fP\\$2
Packit Service dc579d
..
Packit Service dc579d
.de hN
Packit Service dc579d
.ie t <\fB\\$1\fR>\\$2
Packit Service dc579d
.el <\fI\\$1\fP>\\$2
Packit Service dc579d
..
Packit Service dc579d
.ny0
Packit Service dc579d
.TH XCreateOC __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
Packit Service dc579d
.SH NAME
Packit Service dc579d
XCreateOC, XDestroyOC, XSetOCValues, XGetOCValues, XOMOfOC \- create output contexts
Packit Service dc579d
.SH SYNTAX
Packit Service dc579d
.HP
Packit Service dc579d
XOC XCreateOC\^(\^XOM \fIom\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
void XDestroyOC\^(\^XOC \fIoc\fP\^); 
Packit Service dc579d
.HP
Packit Service dc579d
char * XSetOCValues\^(\^XOC \fIoc\fP\^, ...); 
Packit Service dc579d
.HP
Packit Service dc579d
char * XGetOCValues\^(\^XOC \fIoc\fP\^, ...); 
Packit Service dc579d
.HP
Packit Service dc579d
XOM XOMOfOC\^(\^XOC \fIoc\fP\^); 
Packit Service dc579d
.SH ARGUMENTS
Packit Service dc579d
.IP \fIoc\fP 1i
Packit Service dc579d
Specifies the output context.
Packit Service dc579d
.IP \fIom\fP 1i
Packit Service dc579d
Specifies the output method.
Packit Service dc579d
.ds Al \ to set or get XOC values
Packit Service dc579d
.IP ... 1i
Packit Service dc579d
Specifies the variable length argument list\*(Al.
Packit Service dc579d
.SH DESCRIPTION
Packit Service dc579d
The
Packit Service dc579d
.ZN XCreateOC 
Packit Service dc579d
function creates an output context within the specified output method.
Packit Service dc579d
.LP
Packit Service dc579d
The base font names argument is mandatory at creation time, and
Packit Service dc579d
the output context will not be created unless it is provided.
Packit Service dc579d
All other output context values can be set later.
Packit Service dc579d
.LP
Packit Service dc579d
.ZN XCreateOC
Packit Service dc579d
returns NULL if no output context could be created.
Packit Service dc579d
NULL can be returned for any of the following reasons:
Packit Service dc579d
.IP \(bu 5
Packit Service dc579d
A required argument was not set.
Packit Service dc579d
.IP \(bu 5
Packit Service dc579d
A read-only argument was set.
Packit Service dc579d
.IP \(bu 5
Packit Service dc579d
An argument name is not recognized.
Packit Service dc579d
.IP \(bu 5
Packit Service dc579d
The output method encountered an output method implementation-dependent error.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN XDestroyOC
Packit Service dc579d
function destroys the specified output context.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN XSetOCValues
Packit Service dc579d
function returns NULL if no error occurred; 
Packit Service dc579d
otherwise,
Packit Service dc579d
it returns the name of the first argument that could not be set.
Packit Service dc579d
An argument might not be set for any of the following reasons:
Packit Service dc579d
.IP \(bu 5
Packit Service dc579d
The argument is read-only.
Packit Service dc579d
.IP \(bu 5
Packit Service dc579d
The argument name is not recognized.
Packit Service dc579d
.IP \(bu 5
Packit Service dc579d
An implementation-dependent error occurs.
Packit Service dc579d
.LP
Packit Service dc579d
Each value to be set must be an appropriate datum,
Packit Service dc579d
matching the data type imposed by the semantics of the argument.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN XGetOCValues
Packit Service dc579d
function returns NULL if no error occurred; otherwise,
Packit Service dc579d
it returns the name of the first argument that could not be obtained.
Packit Service dc579d
An argument might not be obtained for any of the following reasons:
Packit Service dc579d
.IP \(bu 5
Packit Service dc579d
The argument name is not recognized.
Packit Service dc579d
.IP \(bu 5
Packit Service dc579d
An implementation-dependent error occurs.
Packit Service dc579d
.LP
Packit Service dc579d
Each argument value
Packit Service dc579d
following a name must point to a location where the value is to be stored.
Packit Service dc579d
.LP
Packit Service dc579d
The
Packit Service dc579d
.ZN XOMOfOC
Packit Service dc579d
function returns the output method associated with the
Packit Service dc579d
specified output context.
Packit Service dc579d
.SH "SEE ALSO"
Packit Service dc579d
XCreateOM(__libmansuffix__),
Packit Service dc579d
XCreateFontSet(__libmansuffix__)
Packit Service dc579d
.br
Packit Service dc579d
\fI\*(xL\fP