xref: /freebsd/lib/libc/nls/catclose.3 (revision 77a0943ded95b9e6438f7db70c4a28e4d93946d4)
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.\" $FreeBSD$
30.Dd May 29, 1994
31.Dt CATCLOSE 3
32.Os
33.Sh NAME
34.Nm catclose
35.Nd close message catalog
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.Fd #include <nl_types.h>
40.Ft int
41.Fn catclose "nl_catd catd"
42.Sh DESCRIPTION
43The
44.Fn catclose
45function closes the message catalog specified by the argument
46.Fa catd .
47.Sh RETURN VALUES
48Upon successful completion,
49.Fn catclose
50returns 0.
51Otherwise, -1 is returned and
52.Va errno
53is set to indicate the error.
54.Sh ERRORS
55.Bl -tag -width Er
56.It Bq Er EBADF
57An invalid message catalog descriptor was passed by the
58.Fa catd
59argument.
60.El
61.Sh SEE ALSO
62.Xr gencat 1 ,
63.Xr catgets 3 ,
64.Xr catopen 3
65.Sh STANDARDS
66The
67.Fn catclose
68function conforms to
69.St -xpg4 .
70
71