usr/src/man/man3c/catgets.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright 1989 AT&T
  44 .\" Portions Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved
  45 .\" Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved.
  46 .\"
  47 .TH CATGETS 3C "Mar 22, 2002"
  48 .SH NAME
  49 catgets \- read a program message
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <nl_types.h>
  54
  55 \fBchar *\fR\fBcatgets\fR(\fBnl_catd\fR \fIcatd\fR, \fBint\fR \fIset_num\fR, \fBint\fR \fImsg_num\fR, \fBconst char *\fR\fIs\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 The \fBcatgets()\fR function attempts to read message \fImsg_num\fR, in set
  62 \fIset_num\fR, from the message catalog identified by  \fIcatd\fR. The
  63 \fIcatd\fR argument is a catalog descriptor returned from an earlier call to
  64 \fBcatopen()\fR. The \fIs\fR argument points to a default message string which
  65 will be returned by  \fBcatgets()\fR if the identified message catalog is not
  66 currently available.
  67 .SH RETURN VALUES
  68 .sp
  69 .LP
  70 If the identified message is retrieved successfully,  \fBcatgets()\fR returns a
  71 pointer to an internal buffer area containing the  null terminated message
  72 string. If the call is unsuccessful for any reason, \fBcatgets()\fR returns a
  73 pointer to \fIs\fR and \fBerrno\fR may be set to indicate the error.
  74 .SH ERRORS
  75 .sp
  76 .LP
  77 The \fBcatgets()\fR function may fail if:
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBEBADF\fR\fR
  82 .ad
  83 .RS 11n
  84 The \fIcatd\fR argument is not a valid message catalogue descriptor open for
  85 reading.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fB\fBEBADMSG\fR\fR
  92 .ad
  93 .RS 11n
  94 The number of \fB%n\fR specifiers that appear in the message string specified
  95 by \fIs\fR does not match the number of \fB%n\fR specifiers that appear in the
  96 message identified by \fIset_id\fR and \fImsg_id\fR in the specified message
  97 catalog.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBEINTR\fR\fR
 104 .ad
 105 .RS 11n
 106 The read operation was terminated due to the receipt of a signal, and no data
 107 was transferred.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBEINVAL\fR\fR
 114 .ad
 115 .RS 11n
 116 The message catalog identified by \fIcatd\fR is corrupted.
 117 .RE
 118
 119 .sp
 120 .ne 2
 121 .na
 122 \fB\fBENOMSG\fR\fR
 123 .ad
 124 .RS 11n
 125 The message identified by \fIset_id\fR and \fImsg_id\fR is not in the message
 126 catalog.
 127 .RE
 128
 129 .SH USAGE
 130 .sp
 131 .LP
 132 The \fBcatgets()\fR function can be used safely in multithreaded applications
 133 as long as \fBsetlocale\fR(3C) is not being called to change the locale.
 134 .SH ATTRIBUTES
 135 .sp
 136 .LP
 137 See \fBattributes\fR(5) for descriptions of the following attributes:
 138 .sp
 139
 140 .sp
 141 .TS
 142 box;
 143 c | c
 144 l | l .
 145 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 146 _
 147 Interface Stability     Standard
 148 _
 149 MT-Level        MT-Safe
 150 .TE
 151
 152 .SH SEE ALSO
 153 .sp
 154 .LP
 155 \fBgencat\fR(1), \fBcatclose\fR(3C), \fBcatopen\fR(3C), \fBgettext\fR(3C),
 156 \fBsetlocale\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)
 157 .sp
 158 .LP
 159 \fIInternational Language Environments Guide\fR