lib/libc/nls/catopen.3

   1 .\"     $NetBSD: catopen.3,v 1.14 2003/07/26 19:24:49 salo Exp $
   2 .\"
   3 .\" Written by J.T. Conklin <jtc@NetBSD.org>.
   4 .\" Public domain.
   5 .\"
   6 .Dd May 29, 1994
   7 .Dt CATOPEN 3
   8 .Os
   9 .Sh NAME
  10 .Nm catopen
  11 .Nd open message catalog
  12 .Sh LIBRARY
  13 .Lb libc
  14 .Sh SYNOPSIS
  15 .In nl_types.h
  16 .Ft nl_catd
  17 .Fn catopen "const char *name" "int oflag"
  18 .Sh DESCRIPTION
  19 The
  20 .Fn catopen
  21 function opens the message catalog specified by
  22 .Fa name
  23 and returns a message catalog descriptor.
  24 If
  25 .Fa name
  26 contains a
  27 .Sq /
  28 then
  29 .Fa name
  30 specifies the full pathname for the message catalog, otherwise the value
  31 of the environment variable
  32 .Ev NLSPATH
  33 is used with
  34 .Fa name
  35 substituted for %N.
  36 .Pp
  37 The
  38 .Fa oflag
  39 argument is reserved for future use and should be set to zero.
  40 .Sh RETURN VALUES
  41 Upon successful completion,
  42 .Fn catopen
  43 returns a message catalog descriptor.
  44 Otherwise, (nl_catd) -1 is returned and
  45 .Va errno
  46 is set to indicate the error.
  47 .Sh ERRORS
  48 .Bl -tag -width Er
  49 .It Bq Er ENOMEM
  50 Insufficient memory is available.
  51 .El
  52 .Sh SEE ALSO
  53 .Xr gencat 1 ,
  54 .Xr catclose 3 ,
  55 .Xr catgets 3 ,
  56 .Xr nls 7
  57 .Sh STANDARDS
  58 The
  59 .Fn catopen
  60 function conforms to
  61 .St -xpg3 .