1.\" $FreeBSD$ 2.\" 3.\" Copyright (c) 1994 Winning Strategies, Inc. 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by Winning Strategies, Inc. 17.\" 4. The name of the author may not be used to endorse or promote products 18.\" derived from this software without specific prior written permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 21.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 22.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 23.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 24.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 25.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 29.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 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 "const char *name" "int oflag" 41.Sh DESCRIPTION 42The 43.Fn catopen 44function opens 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 60If the 61.Fa oflag 62argument is set to the 63.Dv NL_CAT_LOCALE 64constant, 65.Dv LC_MESSAGES 66locale category used to open the message catalog; using 67.Dv NL_CAT_LOCALE 68conforms to the 69.St -xpg4 70standard. You can specify 0 for compatibility with 71.St -xpg3 ; 72when 73.Fa oflag 74is set to 0, the 75.Ev LANG 76environment variable 77determines the message catalog locale. 78.Sh RETURN VALUE 79Upon successful completion, 80.Fn catopen 81returns a message catalog descriptor. 82Otherwise, (nl_catd) -1 is returned and 83.Va errno 84is set to indicate the error. 85.Sh ERRORS 86.Bl -tag -width Er 87.It Bq Er ENOMEM 88Insufficient memory is available. 89.El 90.Sh SEE ALSO 91.Xr gencat 1 , 92.Xr catclose 3 , 93.Xr catgets 3 , 94.Xr setlocale 3 95.Sh STANDARDS 96The 97.Fn catopen 98function conforms to 99.St -xpg4 . 100