CATGETS(2,L)                AIX Technical Reference                CATGETS(2,L)



-------------------------------------------------------------------------------
catgets



PURPOSE

Retrieve a message from an open message catalog.

LIBRARY

Standard C Library (libc.a)

SYNTAX

#include <nl_types.h>

char *catgets (catd, set_num, msg_num, s)
nl_catd catd;
int set_num, msg_num;
char *s;

DESCRIPTION

The catgets subroutine retrieves a message from an open message catalog.  The
catd parameter is a catalog descriptor returned from a successful catopen,
set_num and msg_num specify the set and message from the catalog to retrieve,
and s is a default string to return if the specified message cannot be
retrieved.  A pointer to the message from the catalog is returned upon success.
If the call fails for any reason, a pointer to the default string is returned.

RETURN VALUE

The message retrieved by the catgets subroutine is held in a static data
location so the data is overwritten on successive calls to catgets.  It is up
to the user program to copy the message returned to a local buffer to save the
message.

RELATED INFORMATION

The gencat and mkcatdefs commands in AIX Operating System Commands Reference.

The message catalog description in Managing the AIX Operating System.












Processed November 7, 1990       CATGETS(2,L)                                 1