Initial import from FreeBSD RELENG_4:
[dragonfly.git] / lib / libc / nls / catgets.3
CommitLineData
984263bc
MD
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: src/lib/libc/nls/catgets.3,v 1.7.2.4 2001/12/14 18:33:56 ru Exp $
30.Dd May 29, 1994
31.Dt CATGETS 3
32.Os
33.Sh NAME
34.Nm catgets
35.Nd retrieve string from message catalog
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In nl_types.h
40.Ft char *
41.Fn catgets "nl_catd catd" "int set_id" "int msg_id" "const char *s"
42.Sh DESCRIPTION
43The
44.Fn catgets
45function attempts to retrieve message
46.Fa msg_id
47of set
48.Fa set_id
49from the message catalog referenced by the descriptor
50.Fa catd .
51The argument
52.Fa s
53points to a default message which is returned if the function
54is unable to retrieve the specified message.
55.Sh RETURN VALUES
56If the specified message was retrieved successfully,
57.Fn catgets
58returns a pointer to an internal buffer containing the message string;
59otherwise it returns
60.Fa s .
61.Sh SEE ALSO
62.Xr gencat 1 ,
63.Xr catclose 3 ,
64.Xr catopen 3
65.Sh STANDARDS
66The
67.Fn catgets
68function conforms to
69.St -xpg4 .