| 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 | .\" $DragonFly: src/lib/libc/nls/catgets.3,v 1.2 2003/06/17 04:26:44 dillon Exp $ |
| 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 LIBRARY |
| 38 | .Lb libc |
| 39 | .Sh SYNOPSIS |
| 40 | .In nl_types.h |
| 41 | .Ft char * |
| 42 | .Fn catgets "nl_catd catd" "int set_id" "int msg_id" "const char *s" |
| 43 | .Sh DESCRIPTION |
| 44 | The |
| 45 | .Fn catgets |
| 46 | function attempts to retrieve message |
| 47 | .Fa msg_id |
| 48 | of set |
| 49 | .Fa set_id |
| 50 | from the message catalog referenced by the descriptor |
| 51 | .Fa catd . |
| 52 | The argument |
| 53 | .Fa s |
| 54 | points to a default message which is returned if the function |
| 55 | is unable to retrieve the specified message. |
| 56 | .Sh RETURN VALUES |
| 57 | If the specified message was retrieved successfully, |
| 58 | .Fn catgets |
| 59 | returns a pointer to an internal buffer containing the message string; |
| 60 | otherwise it returns |
| 61 | .Fa s . |
| 62 | .Sh SEE ALSO |
| 63 | .Xr gencat 1 , |
| 64 | .Xr catclose 3 , |
| 65 | .Xr catopen 3 |
| 66 | .Sh STANDARDS |
| 67 | The |
| 68 | .Fn catgets |
| 69 | function conforms to |
| 70 | .St -xpg4 . |