Section: POSIX Programmer's Manual (3P)
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
--- open a message catalog
nl_catd catopen(const char *name, int oflag);
function shall open a message catalog and return a message catalog
argument specifies the name of the message catalog to be opened. If
specifies a complete name for the message catalog. Otherwise, the
is used with
substituted for the
conversion specification (see the Base Definitions volume of POSIX.1-2008,
, Environment Variables).
exists in the environment when the process starts, then if the process
has appropriate privileges, the behavior of
is undefined. If
does not exist in the environment, or if a message catalog cannot be
found in any of the components specified by
then an implementation-defined default path shall be used. This default
may be affected by the setting of
if the value of
is NL_CAT_LOCALE, or the
environment variable if
A message catalog descriptor shall remain valid in a process until that
process closes it, or a successful call to one of the
functions. A change in the setting of the
category may invalidate existing open catalogs.
If a file descriptor is used to implement message catalog descriptors,
the FD_CLOEXEC flag shall be set; see
If the value of the
argument is 0, the
environment variable is used to locate the catalog without regard to
category. If the
argument is NL_CAT_LOCALE, the
category is used to locate the message catalog (see the Base Definitions volume of POSIX.1-2008,
Section 8.2, Internationalization Variables).
Upon successful completion,
shall return a message catalog descriptor for use on subsequent calls to
shall return (nl_catd
-1 and set
to indicate the error.
function may fail if:
Search permission is denied for the component of the path prefix of the
message catalog or read permission is denied for the message catalog.
All file descriptors available to the process are currently open.
The length of a component of a pathname is longer than
The length of a pathname exceeds
or pathname resolution of a symbolic link produced an intermediate
result with a length that exceeds
Too many files are currently open in the system.
The message catalog does not exist or the
argument points to an empty string.
Insufficient storage space is available.
A component of the path prefix of the message catalog names an existing
file that is neither a directory nor a symbolic link to a directory,
or the pathname of the message catalog contains at least one non-<slash>
character and ends with one or more trailing
characters and the last pathname component names an existing file
that is neither a directory nor a symbolic link to a directory.
The following sections are informative.
Some implementations of
to allocate space for internal buffer areas. The
function may fail if there is insufficient storage space available to
accommodate these buffers.
Conforming applications must assume that message catalog descriptors are
not valid after a call to one of the
Application developers should be aware that guidelines for the location
of message catalogs have not yet been developed. Therefore they should
take care to avoid conflicting with catalogs used by other applications
and the standard utilities.
The Base Definitions volume of POSIX.1-2008,
Chapter 8, Environment Variables,
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, Copyright (C) 2013 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
(This is POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) 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
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see