NAME

catgets − Retrieves a message from a catalog

LIBRARY

Standard C Library (libc.a)

SYNOPSIS

#include <nl_types.h> char ∗catgets(
        nl_catd cat_descriptor,
        int set_number,
        int message_number,
        const char ∗string);

PARAMETERS

cat_descriptor
Specifies a catalog descriptor that is returned by the catopen() function. 

set_numberSpecifies the set ID. 

message_number
Specifies the message ID. The set_number and message_number parameters specify a particular message in the catalog to retrieve. 

stringSpecifies the default message string. 

DESCRIPTION

The catgets() function retrieves a message from a catalog after a successful call to the catopen() function. If the catgets() function finds the specified message, a pointer to the message text is returned. Otherwise, the function returns a pointer to the default message string. 

NOTES

The returned cat_descriptor pointer is not valid once the catclose() function has been called for that cat_descriptor. 

AES Support Level:
Trial use.

RETURN VALUES

Upon successful completion, the catgets() function returns a pointer to the null terminated message string.  Otherwise, string is returned. 

ERRORS

None possible. 

RELATED INFORMATION

Functions: catopen(3), catclose(3). 

Commands: dspcat(1), dspmsg(1), gencat(1), mkcatdefs(1).