lib/libc/nls/catgets.3

   1 .\" Copyright (c) 1994 Winning Strategies, Inc.
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"      This product includes software developed by Winning Strategies, Inc.
  15 .\" 4. The name of the author may not be used to endorse or promote products
  16 .\"    derived from this software without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28 .Dd February 12, 2005
  29 .Dt CATGETS 3
  30 .Os
  31 .Sh NAME
  32 .Nm catgets
  33 .Nd retrieve string from message catalog
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In nl_types.h
  38 .Ft char *
  39 .Fn catgets "nl_catd catd" "int set_id" "int msg_id" "const char *s"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn catgets
  43 function attempts to retrieve message
  44 .Fa msg_id
  45 of set
  46 .Fa set_id
  47 from the message catalog referenced by the descriptor
  48 .Fa catd .
  49 The argument
  50 .Fa s
  51 points to a default message which is returned if the function
  52 is unable to retrieve the specified message.
  53 .Sh RETURN VALUES
  54 If the specified message was retrieved successfully,
  55 .Fn catgets
  56 returns a pointer to an internal buffer containing the message string;
  57 otherwise it returns
  58 .Fa s .
  59 .Sh ERRORS
  60 .Bl -tag -width Er
  61 .It Bq Er EBADF
  62 The
  63 .Fa catd
  64 argument is not a valid message catalog descriptor.
  65 .It Bq Er EBADMSG
  66 The message identified by
  67 .Fa set_id
  68 and
  69 .Fa msg_id
  70 is not in the message catalog.
  71 .El
  72 .Sh SEE ALSO
  73 .Xr gencat 1 ,
  74 .Xr catclose 3 ,
  75 .Xr catopen 3
  76 .Sh STANDARDS
  77 The
  78 .Fn catgets
  79 function conforms to
  80 .St -p1003.1-2001 .