xref: /netbsd-src/lib/libc/nls/catopen.3 (revision ae9172d6cd9432a6a1a56760d86b32c57a66c39c)
1.\" Copyright (c) 1994 Winning Strategies, Inc.
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"      This product includes software developed by Winning Strategies, Inc.
15.\" 4. The name of the author may not be used to endorse or promote products
16.\"    derived from this software without specific prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28.\"
29.\"	$Id: catopen.3,v 1.2 1994/11/18 15:36:16 jtc Exp $
30.\"
31.Dd May 29, 1994
32.Dt CATOPEN 3
33.Os
34.Sh NAME
35.Nm catopen
36.Nd open message catalog
37.Sh SYNOPSIS
38.Fd #include <nl_types.h>
39.Ft nl_catd
40.Fn catopen "char *name" "int oflag"
41.Sh DESCRIPTION
42.The
43.Fn catopen function
44opens the message catalog specified by
45.Fa name
46and returns a message catalog descriptor.
47If
48.Fa name
49contains a
50.Sq /
51then
52.Fa name
53specifies the full pathname for the message catalog, otherwise the value
54of the environment variable
55.Ev NLSPATH
56is used with
57.Fa name
58substituted for %N.
59.Pp
60The
61.Fa oflag
62argument is reserved for future use and should be set to zero.
63.Sh RETURN VALUE
64Upon successful completion,
65.Fn catopen
66returns a message catalog descriptor.
67Otherwise, (nl_catd) -1 is returned and
68.Va errno
69is set to indicate the error.
70.Sh ERRORS
71.Bl -tag -width Er
72.It Bq Er ENOMEM
73Insufficient memory is availiable.
74.El
75.Sh SEE ALSO
76.Xr catclose 3 ,
77.Xr catgets 3
78.Sh STANDARDS
79The
80.Fn catopen
81function conforms to
82.St -xpg3 .
83