xref: /netbsd/lib/libc/nls/catopen.3 (revision c4a72b64)
1.\"	$NetBSD: catopen.3,v 1.10 2002/10/02 10:45:18 wiz 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.Fd #include \*[Lt]nl_types.h\*[Gt]
16.Ft nl_catd
17.Fn catopen "const char *name" "int oflag"
18.Sh DESCRIPTION
19The
20.Fn catopen
21function opens the message catalog specified by
22.Fa name
23and returns a message catalog descriptor.
24If
25.Fa name
26contains a
27.Sq /
28then
29.Fa name
30specifies the full pathname for the message catalog, otherwise the value
31of the environment variable
32.Ev NLSPATH
33is used with
34.Fa name
35substituted for %N.
36.Pp
37The
38.Fa oflag
39argument is reserved for future use and should be set to zero.
40.Sh RETURN VALUES
41Upon successful completion,
42.Fn catopen
43returns a message catalog descriptor.
44Otherwise, (nl_catd) -1 is returned and
45.Va errno
46is set to indicate the error.
47.Sh ERRORS
48.Bl -tag -width Er
49.It Bq Er ENOMEM
50Insufficient memory is available.
51.El
52.Sh SEE ALSO
53.Xr catclose 3 ,
54.Xr catgets 3
55.Sh STANDARDS
56The
57.Fn catopen
58function conforms to
59.St -xpg3 .
60