1.\" $Id: catgets.3,v 1.4 1997/02/22 15:00:46 peter Exp $ 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 CATGETS 3 33.Os 34.Sh NAME 35.Nm catgets 36.Nd retrieve string from message catalog 37.Sh SYNOPSIS 38.Fd #include <nl_types.h> 39.Ft char * 40.Fn catgets "nl_catd catd" "int set_id" "int msg_id" "const char *s" 41.Sh DESCRIPTION 42The 43.Fn catgets 44function attempts to retrieve message 45.Fa msg_id 46of set 47.Fa set_id 48from the message catalog referenced by the descriptor 49.Fa catd . 50The argument 51.Fa s 52points to a default message which is returned if the function 53is unable to retrieve the specified message. 54.Sh RETURN VALUE 55If the specified message was retrieved successfully, 56.Fn catgets 57returns a pointer to an internal buffer containing the message string; 58otherwise it returns 59.Fa s . 60.Sh SEE ALSO 61.Xr catclose 3 , 62.Xr catopen 3 63.Sh STANDARDS 64The 65.Fn catgets 66function conforms to 67.St -xpg4 . 68