Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

nl_types.h(7posix) [linux man page]

<nl_types.h>(P) 					     POSIX Programmer's Manual						   <nl_types.h>(P)

NAME

       nl_types.h - data types

SYNOPSIS

       #include <nl_types.h>

DESCRIPTION

       The <nl_types.h> header shall contain definitions of at least the following types:

       nl_catd
	      Used by the message catalog functions catopen(), catgets(), and catclose() to identify a catalog descriptor.

       nl_item
	      Used by nl_langinfo() to identify items of langinfo data.  Values of objects of type nl_item are defined in <langinfo.h> .

       The <nl_types.h> header shall contain definitions of at least the following constants:

       NL_SETD
	      Used  by gencat when no $set directive is specified in a message text source file; see the Internationalization Guide. This constant
	      can be passed as the value of set_id on subsequent calls to catgets() (that is, to retrieve messages from the default message  set).
	      The value of NL_SETD is implementation-defined.

       NL_CAT_LOCALE
	      Value  that  must  be  passed as the oflag argument to catopen() to ensure that message catalog selection depends on the LC_MESSAGES
	      locale category, rather than directly on the LANG environment variable.

       The following shall be declared as functions and may also be defined as macros. Function prototypes shall be provided.

	      int	catclose(nl_catd);
	      char     *catgets(nl_catd, int, int, const char *);
	      nl_catd	catopen(const char *, int);

       The following sections are informative.

APPLICATION USAGE

       None.

RATIONALE

       None.

FUTURE DIRECTIONS

       None.

SEE ALSO

       <langinfo.h> , the System Interfaces volume of IEEE Std 1003.1-2001, catclose(), catgets(), catopen(), nl_langinfo(), the Shell and  Utili-
       ties volume of IEEE Std 1003.1-2001, gencat

COPYRIGHT

       Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2003 Edition, Standard for Information Technol-
       ogy -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
       Electrical  and	Electronics  Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE
       and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can  be  obtained
       online at http://www.opengroup.org/unix/online.html .

IEEE
/The Open Group						       2003							   <nl_types.h>(P)

Check Out this Related Man Page

CATOPEN(3)						   BSD Library Functions Manual 						CATOPEN(3)

NAME

     catopen -- open message catalog

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <nl_types.h>

     nl_catd
     catopen(const char *name, int oflag);

DESCRIPTION

     The catopen() function opens the message catalog specified by name and returns a message catalog descriptor.  If name contains a '/' then
     name specifies the full pathname for the message catalog, otherwise the value of the environment variable NLSPATH is used with the following
     substitutions:

     %N   The value of the name argument.

     %L   The value of the LANG environment variable or the LC_MESSAGES category (see below).

     %l   The language element from the LANG environment variable or from the LC_MESSAGES category.

     %t   The territory element from the LANG environment variable or from the LC_MESSAGES category.

     %c   The codeset element from the LANG environment variable or from the LC_MESSAGES category.

     %%   A single % character.

     An empty string is substituted for undefined values.

     Path names templates defined in NLSPATH are separated by colons (':').  A leading or two adjacent colons is equivalent to specifying %N.

     If the oflag argument is set to the NL_CAT_LOCALE constant, LC_MESSAGES locale category used to open the message catalog; using NL_CAT_LOCALE
     conforms to the X/Open Portability Guide Issue 4 (``XPG4'') standard.  You can specify 0 for compatibility with X/Open Portability Guide
     Issue 3 (``XPG3''); when oflag is set to 0, the LANG environment variable determines the message catalog locale.

     A message catalog descriptor remains valid in a process until that process closes it, or until a successful call to one of the exec(3) func-
     tion.

RETURN VALUES

     Upon successful completion, catopen() returns a message catalog descriptor.  Otherwise, (nl_catd) -1 is returned and errno is set to indicate
     the error.

ERRORS

     [EINVAL]		Argument name does not point to a valid message catalog, or catalog is corrupt.

     [ENAMETOOLONG]	An entire path to the message catalog exceeded 1024 characters.

     [ENOENT]		The named message catalog does not exists, or the name argument points to an empty string.

     [ENOMEM]		Insufficient memory is available.

SEE ALSO

     gencat(1), catclose(3), catgets(3), setlocale(3)

STANDARDS

     The catopen() function conforms to IEEE Std 1003.1-2001 (``POSIX.1'').

BSD
								 February 12, 2005							       BSD
Man Page