catgets(3) [osf1 man page]

catgets(3)						     Library Functions Manual							catgets(3)

NAME

       catgets - Retrieves a message from a catalog

LIBRARY

       Standard C Library (libc)

SYNOPSIS

       #include <nl_types.h>

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

STANDARDS

       Interfaces documented on this reference page conform to industry standards as follows:

       catgets(): XSH5.0

       Refer to the standards(5) reference page for more information about industry standards and associated tags.

PARAMETERS

       Specifies  a  catalog  descriptor that is returned by the catopen() function.  Identifies a message set.  Identifies a message. In combina-
       tion, the set_number and message_number identify the particular message in the catalog to retrieve.  Specifies the default  message  string
       to be returned if catgets() cannot retrieve the message from the catalog.

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, a pointer to the message text is returned. Otherwise, the function 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

       On  successful completion, the catgets() function returns a pointer to the null terminated message string retrieved from the catalog.  Oth-
       erwise, the function returns a pointer to string and sets errno to indicate the error.

ERRORS

       If the catgets() function fails, it sets errno to one of the following values for the reason specified: [Tru64 UNIX]  Search permission	is
       denied for a component of the path to the message catalog or read permission is denied for the catalog.

	      [Tru64  UNIX]  This  error  may occur on the first invocation of catgets(). See catopen(3) for more information.	The cat_descriptor
	      value does not identify a message catalog that is open for reading.  The cat_descriptor argument is  corrupted.	[Tru64	UNIX]  The
	      process limit for open file descriptors per process has already reached OPEN_MAX.

	      [Tru64  UNIX]  This  error  may  occur on the first invocation of catgets(). See catopen(3) for more information.  [Tru64 UNIX]  The
	      system limit for open file descriptors has been reached.	[Tru64 UNIX]  The message catalog does not exist.

	      [Tru64 UNIX]  This error may occur on the first invocation of catgets(). See catopen(3) for more information.  [Tru64  UNIX]  Insuf-
	      ficient memory is available.

	      [Tru64  UNIX]  This  error may occur on the first invocation of catgets(). See catopen(3) for more information.  The message identi-
	      fied by set_number and message_number is not in the catalog.

RELATED INFORMATION

       Functions: catopen(3), catclose(3)

       Commands: dspcat(1), dspmsg(1), extract(1), gencat(1), mkcatdefs(1), strextract(1), strmerge(1), trans(1)

       Others: i18n_intro(5), l10n_intro(5), standards(5)

       Writing Software for the International Market delim off

																	catgets(3)

Check Out this Related Man Page

CATGETS(3)						     Linux Programmer's Manual							CATGETS(3)

NAME

       catgets - get message from a message catalog

SYNOPSIS

       #include <nl_types.h>

       char *catgets(nl_catd catalog, int set_number, int message_number,
		     const char *message);

DESCRIPTION

       catgets()  reads  the message message_number, in set set_number, from the message catalog identified by catalog, where catalog is a catalog
       descriptor returned from an earlier call to catopen(3).	The fourth argument, message, points to a default message  string  which  will	be
       returned  by  catgets()	if the identified message catalog is not currently available.  The message-text is contained in an internal buffer
       area and should be copied by the application if it is to be saved or modified.  The return string is always terminated  with  a	null  byte
       ('').

RETURN VALUE

       On  success,  catgets()	returns a pointer to an internal buffer area containing the null-terminated message string.  On failure, catgets()
       returns the value message.

ATTRIBUTES

       For an explanation of the terms used in this section, see attributes(7).

       +----------+---------------+---------+
       |Interface | Attribute	  | Value   |
       +----------+---------------+---------+
       |catgets() | Thread safety | MT-Safe |
       +----------+---------------+---------+
CONFORMING TO

       POSIX.1-2001, POSIX.1-2008.

NOTES

       The catgets() function is available only in libc.so.4.4.4c and above.  The Jan 1987 X/Open Portability Guide specifies a more subtle  error
       return:	message  is returned if the message catalog specified by catalog is not available, while an empty string is returned when the mes-
       sage catalog is available but does not contain the specified message.  These two possible error returns seem to be discarded  in  SUSv2	in
       favor of always returning message.

SEE ALSO

       catopen(3), setlocale(3)

COLOPHON

       This  page is part of release 4.15 of the Linux man-pages project.  A description of the project, information about reporting bugs, and the
       latest version of this page, can be found at https://www.kernel.org/doc/man-pages/.

								    2015-08-08								CATGETS(3)

Linux and UNIX Man Pages

catgets(3) [osf1 man page]

Check Out this Related Man Page