catopen(3) [mojave 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

CATOPEN(3)						     Library Functions Manual							CATOPEN(3)

NAME

       catopen, catclose - open/close a message catalog

SYNOPSIS

       #include <nl_types.h>

       nl_catd catopen(const char *name, int flag);
       int catclose(nl_catd catalog);

DESCRIPTION

       The  function catopen() opens a message catalog and returns a catalog descriptor.  The descriptor remains valid until catclose() or exec().
       If a file descriptor is used to implement catalog descriptors then the FD_CLOEXEC flag will be set.

       The argument name specifies the name of the message catalog to be opened.  If name specifies and absolute path (i.e., contains a '/'), then
       name  specifies	a pathname for the message catalog.  Otherwise, the environment variable NLSPATH is used with name substituted for %N (see
       locale(7)).  It is unspecified whether NLSPATH will be used when the process has root privileges.  If NLSPATH does not exist in	the  envi-
       ronment,  or  if a message catalog cannot be opened in any of the paths specified by it, then an implementation defined path is used.  This
       latter default path may depend on the LC_MESSAGES locale setting when the flag argument is NL_CAT_LOCALE and on the LANG environment  vari-
       able when the flag argument is 0.  Changing the LC_MESSAGES part of the locale may invalidate open catalog descriptors.

       The  flag argument to catopen() is used to indicate the source for the language to use.	If it is set to NL_CAT_LOCALE then it will use the
       current locale setting for LC_MESSAGES.	Otherwise it will use the LANG environment variable.

       The function catclose() closes the message catalog identified by catalog.  It invalidates any subsequent references to the message  catalog
       defined by catalog.

RETURN VALUE

       The function catopen() returns a message catalog descriptor of type nl_catd on success.	On failure, it returns (nl_catd) -1 and sets errno
       to indicate the error. The possible error values include all possible values for the open() call.

       The function catclose() returns 0 on success, or -1 on failure.

ENVIRONMENT

       LC_MESSAGES
	      May be the source of the LC_MESSAGES locale setting, and thus determine the language to use if flag is set to NL_CAT_LOCALE.

       LANG   The language to use if flag is 0.

NOTES

       The above is the POSIX 1003.1-2001 description.	The glibc value for NL_CAT_LOCALE is 1.  (Compare  MCLoadAll  below.)	The  default  path
       varies, but usually looks at a number of places below /usr/share/locale.

NOTES FOR LIBC4 AND LIBC5
       These  functions  are  available  for  Linux  since libc 4.4.4c.  In the case of linux libc4 and libc5, the catalog descriptor nl_catd is a
       mmap()'ed area of memory and not a file descriptor.  The flag argument to catopen() should be either MCLoadBySet (=0)  or  MCLoadAll  (=1).
       The former value indicates that a set from the catalog is to be loaded when needed, whereas the latter causes the initial call to catopen()
       to load the entire catalog into memory.	The default search path varies, but usually looks at a number  of  places  below  /etc/locale  and
       /usr/lib/locale.

CONFORMING TO

       POSIX  1003.1-2001.   In  XPG  1987, Vol. 3 it says: The flag argument of catopen is reserved for future use and should be set to 0.  It is
       unclear what the source was for the constants MCLoadBySet and MCLoadAll.

SEE ALSO

       catgets(3), setlocale(3)

								    2001-12-14								CATOPEN(3)