Guardian Native C Library Calls Reference Manual (G06.29+, H06.08+, J06.03+)

Guardian Native C Library Calls (a - e) catgets(3)
NAME
catgets - Retrieves a message from a catalog
LIBRARY
G-series native OSS processes: /G/system/sysnn/zcrtlsrl
32-bit H-series and J-series OSS processes: /G/system/zdllnnn/zcrtldll
64-bit H-series and J-series OSS processes: /G/system/zdllnnn/ycrtldll
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 description that is returned by the catopen( ) function.
set_number Specifies 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.
string Specifies 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, it returns a pointer to the message
text. Otherwise, it 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.
RETURN VALUES
Upon successful completion, the catgets() function returns a pointer the null terminated message
string. Otherwise, string is returned.
RELATED INFORMATION
Functions: catopen(3), catclose(3).
Commands: gencat(1), mkcatdefs(1).
527192-018 Hewlett-Packard Company 1−85