1995-05-12 03:03:44 +04:00
|
|
|
.\" $NetBSD: catgets.3,v 1.5 1995/05/11 23:03:44 jtc Exp $
|
1995-02-27 16:06:20 +03:00
|
|
|
.\"
|
1995-05-12 03:03:44 +04:00
|
|
|
.\" Written by J.T. Conklin <jtc@netbsd.org>.
|
|
|
|
.\" Public domain.
|
1994-05-30 04:53:56 +04:00
|
|
|
.\"
|
|
|
|
.Dd May 29, 1994
|
|
|
|
.Dt CATGETS 3
|
|
|
|
.Os
|
|
|
|
.Sh NAME
|
|
|
|
.Nm catgets
|
|
|
|
.Nd retrieve string from message catalog
|
|
|
|
.Sh SYNOPSIS
|
|
|
|
.Fd #include <nl_types.h>
|
1994-10-05 20:31:50 +03:00
|
|
|
.Ft char *
|
1994-05-30 04:53:56 +04:00
|
|
|
.Fn catgets "nl_catd catd" "int set_id" "int msg_id" "char *s"
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
The
|
|
|
|
.Fn catgets
|
|
|
|
function attempts to retrieve message
|
|
|
|
.Fa msg_id
|
|
|
|
of set
|
|
|
|
.Fa set_id
|
|
|
|
from the message catalog referenced by the descriptor
|
|
|
|
.Fa catd .
|
|
|
|
The argument
|
|
|
|
.Fa s
|
|
|
|
points to a default message which is returned if the function
|
|
|
|
is unable to retrieve the specified message.
|
|
|
|
.Sh RETURN VALUE
|
|
|
|
If the specified message was retrieved successfully,
|
|
|
|
.Fn catgets
|
|
|
|
returns a pointer to an internal buffer containing the message string;
|
|
|
|
otherwise it returns
|
|
|
|
.Fa s .
|
|
|
|
.Sh SEE ALSO
|
|
|
|
.Xr catclose 3 ,
|
|
|
|
.Xr catopen 3
|
1994-11-18 18:36:11 +03:00
|
|
|
.Sh STANDARDS
|
|
|
|
The
|
|
|
|
.Fn catgets
|
|
|
|
function conforms to
|
|
|
|
.St -xpg3 .
|