.\"	$OpenBSD: catopen.3,v 1.6 2007/05/31 19:19:30 jmc Exp $
.\"
.\" Written by J.T. Conklin <jtc@netbsd.org>.
.\" Public domain.
.\"
.Dd $Mdocdate: May 31 2007 $
.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
.Ql / ,
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
.Ql \&%N .
.Pp
The
.Fa oflag
argument is reserved for future use and should be set to zero.
.Sh RETURN VALUES
Upon successful completion,
.Fn catopen
returns a message catalog descriptor.
Otherwise, \-1 is returned and
.Va errno
is set to indicate the error.
.Sh ERRORS
.Bl -tag -width Er
.It Bq Er ENOMEM
Insufficient memory available.
.El
.Sh SEE ALSO
.Xr catclose 3 ,
.Xr catgets 3
.Sh STANDARDS
The
.Fn catopen
function conforms to
.St -xpg3 .