CATGETS(3)                      Domain/OS BSD                       CATGETS(3)



NAME
     catgets - Retrieves a program message from a catalog

SYNOPSIS
     #include <nl_types.h>

     char *catgets (cat_descriptor, set_number, message_number, string )
     nl_catd cat_descriptor;
     int set_number;
     int message_number;
     const char *string;

DESCRIPTION
     The catgets function retrieves a message from a catalog after a
     successful call to the catopen(3C) function has been performed. If the
     catgets function finds the specified message, it loads that message into
     a character string buffer, terminates the message string with a null
     character, and returns a pointer to the buffer. The message in the buffer
     may be overwritten by the next call to the catgets function.

     The arguments are as follows:

     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
          arguments specify a particular message in the catalog to retrieve.

     string
          Points to a default message string that is returned by catgets if it
          cannot retrieve the identified message.


DIAGNOSTICS
     Upon successful completion, the catgets function returns a pointer to an
     internal buffer area containing the null terminated message string.
     Otherwise, string is returned.

SEE ALSO
     catopen(3), catclose(3),