catgets(S)

catgets -- read a program message

Synopsis

   #include <nl_types.h>
   
   char catgets(nl_catd catd, int set_num, int msg_num, const char s);

Description

catgets attempts to read message msg_num, in set set_num, from the message catalogue identified by catd. catd is a catalogue descriptor returned from an earlier successful call to catopen. s points to a default message string which will be returned by catgets if the identified message catalogue is not currently available.

Return values

If the identified message is retrieved successfully, catgets returns a pointer to an internal buffer area containing the null-terminated message string. If the call is unsuccessful because the message catalogue identified by catd is not currently available, the value of s is returned.

References

catopen(S)