Content-type: text/html Man page of catgets

catgets

Section: C Library Functions (3)
Index Return to Main Contents
 

NAME

catgets - Retrieves a message from a catalog  

LIBRARY

Standard C Library (libc.so, libc.a)  

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(): XPG4

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 combination, 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. Otherwise, the function returns a pointer to string.

The function can fail for the following reasons: The cat_descriptor value is an invalid descriptor. The function was interrupted by a signal. The catalog identified by cat_descriptor value is corrupt. The identified message is not in the specified message 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


 

Index

NAME
LIBRARY
SYNOPSIS
STANDARDS
PARAMETERS
DESCRIPTION
NOTES
RETURN VALUES
RELATED INFORMATION

This document was created by man2html, using the manual pages.
Time: 02:41:54 GMT, October 02, 2010