man/XtAppGetErrorDatabase.man

   1 .\" Copyright 1993 X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be
  12 .\" included in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  15 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .\" Except as contained in this notice, the name of the X Consortium shall
  23 .\" not be used in advertising or otherwise to promote the sale, use or
  24 .\" other dealings in this Software without prior written authorization
  25 .\" from the X Consortium.
  26 .\"
  27 .ds tk X Toolkit
  28 .ds xT X Toolkit Intrinsics \- C Language Interface
  29 .ds xI Intrinsics
  30 .ds xW X Toolkit Athena Widgets \- C Language Interface
  31 .ds xL Xlib \- C Language X Interface
  32 .ds xC Inter-Client Communication Conventions Manual
  33 .ds Rn 3
  34 .ds Vn 2.2
  35 .hw XtApp-Get-Error-Database XtApp-Get-Error-Database-Text wid-get
  36 .na
  37 .de Ds
  38 .nf
  39 .\\$1D \\$2 \\$1
  40 .ft CW
  41 .ps \\n(PS
  42 .\".if \\n(VS>=40 .vs \\n(VSu
  43 .\".if \\n(VS<=39 .vs \\n(VSp
  44 ..
  45 .de De
  46 .ce 0
  47 .if \\n(BD .DF
  48 .nr BD 0
  49 .in \\n(OIu
  50 .if \\n(TM .ls 2
  51 .sp \\n(DDu
  52 .fi
  53 ..
  54 .de IN          \" send an index entry to the stderr
  55 ..
  56 .de Pn
  57 .ie t \\$1\fB\^\\$2\^\fR\\$3
  58 .el \\$1\fI\^\\$2\^\fP\\$3
  59 ..
  60 .de ZN
  61 .ie t \fB\^\\$1\^\fR\\$2
  62 .el \fI\^\\$1\^\fP\\$2
  63 ..
  64 .ny0
  65 .TH XtAppGetErrorDatabase __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
  66 .SH NAME
  67 XtAppGetErrorDatabase, XtAppGetErrorDatabaseText \- obtain error database
  68 .SH SYNTAX
  69 .HP
  70 XrmDatabase *XtAppGetErrorDatabase(\^XtAppContext \fIapp_context\fP);
  71 .HP
  72 void XtAppGetErrorDatabaseText(XtAppContext \fIapp_context\fP, char
  73 *\fIname\fP, char *\fItype\fP, char *\fIclass\fP, char *\fIdefault\fP, char
  74 *\fIbuffer_return\fP, int \fInbytes\fP, XrmDatabase \fIdatabase\fP);
  75 .SH ARGUMENTS
  76 .IP \fIapp_context\fP 1i
  77 Specifies the application context.
  78 .IP \fIbuffer_return\fP 1i
  79 Specifies the buffer into which the error message is to be returned.
  80 .ds Cl \ of the error message
  81 .IP \fIclass\fP 1i
  82 Specifies the resource class\*(Cl.
  83 .IP \fIdatabase\fP 1i
  84 Specifies the name of the alternative database that is to be used
  85 or NULL if the application's database is to be used.
  86 .IP \fIdefault\fP 1i
  87 Specifies the default message to use\*(Dm.
  88 .IP \fIname\fP 1i
  89 .br
  90 .ns
  91 .IP \fItype\fP 1i
  92 Specifies the name and type that are concatenated to form the resource name
  93 of the error message.
  94 .IP \fInbytes\fP 1i
  95 Specifies the size of the buffer in bytes.
  96 .SH DESCRIPTION
  97 The
  98 .ZN XtAppGetErrorDatabase
  99 function returns the address of the error database.
 100 The \*(xI do a lazy binding of the error database and do not merge in the
 101 database file until the first call to
 102 .ZN XtAppGetErrorDatbaseText .
 103 .LP
 104 The
 105 .ZN XtAppGetErrorDatabaseText
 106 returns the appropriate message from the error database
 107 or returns the specified default message if one is not found in the
 108 error database.
 109 .SH "SEE ALSO"
 110 XtAppError(__libmansuffix__),
 111 XtAppErrorMsg(__libmansuffix__)
 112 .br
 113 \fI\*(xT\fP
 114 .br
 115 \fI\*(xL\fP