Standard C Library Functions                          catgets(3C)



NAME
     catgets - read a program message

SYNOPSIS
     #include 

     char *catgets(nlcatd catd, int setnum, int msgnum, const char *s);


DESCRIPTION
     The catgets() function attempts to read message msgnum,  in
     set  setnum,  from the message catalog identified by  catd.
     The catd argument is a catalog descriptor returned  from  an
     earlier  call  to   catopen().  The  s  argument points to a
     default message string which will be returned by   catgets()
     if  the  identified  message catalog is not currently avail-
     able.

RETURN VALUES
     If the identified message is retrieved  successfully,   cat-
     gets() returns a pointer to an internal buffer area contain-
     ing the  null terminated message  string.  If  the  call  is
     unsuccessful  for any reason, catgets() returns a pointer to
     s and errno may be set to indicate the error.

ERORS
     The catgets() function may fail if:

     EBADF      The catd argument is not a valid message  catalo-
                gue descriptor open for reading.


     EBADMSG    The number of %n specifiers that  appear  in  the
                message  string specified by s does not match the
                number of %n specifiers that appear in  the  mes-
                sage  identified  by  setid  and  msgid  in the
                specified message catalog.


     EINTR      The read operation  was  terminated  due  to  the
                receipt of a signal, and no data was transferred.


     EINVAL     The message catalog identified by  catd  is  cor-
                rupted.


     ENOMSG     The message identified by setid  and  msgid  is
                not in the message catalog.






SunOS 5.11          Last change: 22 Mar 2002                    1






Standard C Library Functions                          catgets(3C)



USAGE
     The catgets() function can be used safely  in  multithreaded
     applications as long as setlocale(3C) is not being called to
     change the locale.

ATRIBUTES
     See attributes(5) for descriptions of the  following  attri-
     butes:



     
           ATRIBUTE TYPE               ATRIBUTE VALUE       
    
     Interface Stability          Standard                    
    
     MT-Level                     MT-Safe                     
    


SEE ALSO
     gencat(1),    catclose(3C),    catopen(3C),     gettext(3C),
     setlocale(3C), attributes(5), standards(5)


     International Language Environments Guide





























SunOS 5.11          Last change: 22 Mar 2002                    2