NetBSD/lib/libc/nls/catopen.3

60 lines
1.1 KiB
Groff
Raw Normal View History

2001-09-16 06:22:27 +04:00
.\" $NetBSD: catopen.3,v 1.8 2001/09/16 02:22:27 wiz Exp $
1995-02-27 16:06:20 +03:00
.\"
.\" Written by J.T. Conklin <jtc@netbsd.org>.
.\" Public domain.
1994-05-30 07:40:36 +04:00
.\"
.Dd May 29, 1994
.Dt CATOPEN 3
.Os
.Sh NAME
.Nm catopen
2001-09-16 06:21:00 +04:00
.Nd open message catalog
1998-02-05 21:45:17 +03:00
.Sh LIBRARY
.Lb libc
1994-05-30 07:40:36 +04:00
.Sh SYNOPSIS
.Fd #include <nl_types.h>
.Ft nl_catd
.Fn catopen "const char *name" "int oflag"
1994-05-30 07:40:36 +04:00
.Sh DESCRIPTION
2001-09-16 06:21:00 +04:00
The
.Fn catopen
function opens the message catalog specified by
2001-09-16 06:21:00 +04:00
.Fa name
1994-05-30 07:40:36 +04:00
and returns a message catalog descriptor.
If
.Fa name
contains a
2001-09-16 06:21:00 +04:00
.Sq /
then
1994-05-30 07:40:36 +04:00
.Fa name
2001-09-16 06:21:00 +04:00
specifies the full pathname for the message catalog, otherwise the value
1994-05-30 07:40:36 +04:00
of the environment variable
2001-09-16 06:21:00 +04:00
.Ev NLSPATH
is used with
1994-05-30 07:40:36 +04:00
.Fa name
substituted for %N.
.Pp
The
.Fa oflag
argument is reserved for future use and should be set to zero.
2001-09-16 06:22:27 +04:00
.Sh RETURN VALUES
2001-09-16 06:21:00 +04:00
Upon successful completion,
1994-05-30 07:40:36 +04:00
.Fn catopen
returns a message catalog descriptor.
Otherwise, (nl_catd) -1 is returned and
2001-09-16 06:21:00 +04:00
.Va errno
1994-05-30 07:40:36 +04:00
is set to indicate the error.
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er ENOMEM
Insufficient memory is availiable.
.El
.Sh SEE ALSO
.Xr catclose 3 ,
.Xr catgets 3
.Sh STANDARDS
The
.Fn catopen
function conforms to
.St -xpg3 .