NAME

catgets − get a program message

SYNOPSIS

#include <nl_types.h>

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

DESCRIPTION

Catgets reads message msg_num in set set_num from the message catalog identified by catd, a catalog descriptor returned from a previous call to catopen(3C). Def_str points to a default message string returned by catgets if the call fails. 

A message longer than NL_TEXTMAX bytes is silently truncated.  The returned message string is always terminated with a null byte.  NL_TEXTMAX is defined in <limits.h>. 

RETURN VALUE

If the call is successful, catgets returns a pointer to an internal buffer area containing the null-terminated message string.  If the call is unsuccessful catgets returns a pointer to def_str.

WARNINGS

Catgets returns a pointer to a static area that is overwritten on each call. 

AUTHOR

Catgets was developed by HP. 

SEE ALSO

catopen(3C), catgetmsg(3C). 

EXTERNAL INFLUENCES

International Code Set Support

Single- and multi-byte character code sets are supported. 

STANDARDS CONFORMANCE

catgets: XPG2, XPG3

Hewlett-Packard Company  —  HP-UX Release 7.0: Sept 1989