summaryrefslogtreecommitdiff
path: root/lib/libc/nls/catopen.3
blob: 71125c7650ed9c6e6ba7e7e4770bbe351e187ccd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
.\"	$NetBSD: catopen.3,v 1.5 1995/05/11 23:04:35 jtc Exp $
.\"
.\" Written by J.T. Conklin <jtc@netbsd.org>.
.\" Public domain.
.\"
.Dd May 29, 1994
.Dt CATOPEN 3
.Os
.Sh NAME
.Nm catopen
.Nd open message catalog 
.Sh SYNOPSIS
.Fd #include <nl_types.h>
.Ft nl_catd
.Fn catopen "const char *name" "int oflag"
.Sh DESCRIPTION
The 
.Fn catopen
function opens the message catalog specified by
.Fa name 
and returns a message catalog descriptor.
If
.Fa name
contains a
.Sq / 
then 
.Fa name
specifies the full pathname for the message catalog, otherwise the value 
of the environment variable
.Ev NLSPATH 
is used with 
.Fa name
substituted for %N.
.Pp
The
.Fa oflag
argument is reserved for future use and should be set to zero.
.Sh RETURN VALUE
Upon successful completion, 
.Fn catopen
returns a message catalog descriptor.
Otherwise, (nl_catd) -1 is returned and
.Va errno 
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 .