xenocara/lib/libXt/man/XtDisplayStringConversionWarning.man
2013-05-31 15:37:25 +00:00

99 lines
3.0 KiB
Groff

.\" Copyright (c) 1993, 1994 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 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 dealing in this Software without prior written authorization
.\" from the X Consortium.
.\"
.ds tk X Toolkit
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xI Intrinsics
.ds xW X Toolkit Athena Widgets \- C Language Interface
.ds xL Xlib \- C Language X Interface
.ds xC Inter-Client Communication Conventions Manual
.ds Rn 3
.ds Vn 2.2
.hw XtDisplay-String-Conversion-Warning wid-get
.na
.de Ds
.nf
.\\$1D \\$2 \\$1
.ft CW
.ps \\n(PS
.\".if \\n(VS>=40 .vs \\n(VSu
.\".if \\n(VS<=39 .vs \\n(VSp
..
.de De
.ce 0
.if \\n(BD .DF
.nr BD 0
.in \\n(OIu
.if \\n(TM .ls 2
.sp \\n(DDu
.fi
..
.de IN \" send an index entry to the stderr
..
.de Pn
.ie t \\$1\fB\^\\$2\^\fR\\$3
.el \\$1\fI\^\\$2\^\fP\\$3
..
.de ZN
.ie t \fB\^\\$1\^\fR\\$2
.el \fI\^\\$1\^\fP\\$2
..
.ny0
.TH XtDisplayStringConversionWarning __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
.SH NAME
XtDisplayStringConversionWarning \- issue a conversion warning message
.SH SYNTAX
.HP
void XtDisplayStringConversionWarning(Display* \fIdisplay\fP, String
\fIfrom_value\fP, \fIto_type\fP);
.SH ARGUMENTS
.IP \fIdisplay\fP 1i
Specifies the display connection with which the conversion is associated.
.IP \fIfrom_value\fP 1i
Specifies the string that could not be converted.
.IP \fIto_type\fP 1i
Specifies the target representation type requested.
.SH DESCRIPTION
The
.ZN XtDisplayStringConversionWarning
function issues a warning message using
.ZN XtAppWarningMsg
with name ``conversionError'', type ``string'', class ``XtToolkitError,
and the default message string ``Cannot convert "\fIfrom_value\fP" to
type \fIto_type\fP''.
.LP
To issue other types of warning or error messages, the type converter
should use
.ZN XtAppWarningMsg
or
.ZN XtAppErrorMsg .
.SH "SEE ALSO"
XtAppWarningMsg(3t)
.br
\fI\*(xT\fP
.br
\fI\*(xL\fP