|
HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|
|
NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUE | ENVIRONMENT | ATTRIBUTES | VERSIONS | STANDARDS | HISTORY | SEE ALSO | COLOPHON |
|
|
|
catopen(3) Library Functions Manual catopen(3)
catopen, catclose - open/close a message catalog
Standard C library (libc, -lc)
#include <nl_types.h>
nl_catd catopen(const char *name, int flag);
int catclose(nl_catd catalog);
The function catopen() opens a message catalog and returns a
catalog descriptor. The descriptor remains valid until
catclose() or execve(2). 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 an 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 environment, 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 variable
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.
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(2) call.
The function catclose() returns 0 on success, or -1 on failure.
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.
For an explanation of the terms used in this section, see
attributes(7).
┌─────────────────────────────────┬───────────────┬─────────────┐
│ Interface │ Attribute │ Value │
├─────────────────────────────────┼───────────────┼─────────────┤
│ catopen() │ Thread safety │ MT-Safe env │
├─────────────────────────────────┼───────────────┼─────────────┤
│ catclose() │ Thread safety │ MT-Safe │
└─────────────────────────────────┴───────────────┴─────────────┘
The above is the POSIX.1 description. The glibc value for
NL_CAT_LOCALE is 1. The default path varies, but usually looks
at a number of places below /usr/share/locale.
POSIX.1-2008.
POSIX.1-2001.
catgets(3), setlocale(3)
This page is part of the man-pages (Linux kernel and C library
user-space interface documentation) project. Information about
the project can be found at
⟨https://www.kernel.org/doc/man-pages/⟩. If you have a bug report
for this manual page, see
⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
This page was obtained from the tarball man-pages-6.9.1.tar.gz
fetched from
⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
2024-06-26. If you discover any rendering problems in this HTML
version of the page, or you believe there is a better or more up-
to-date source for the page, or you have corrections or
improvements to the information in this COLOPHON (which is not
part of the original manual page), send a mail to
[email protected]
Linux man-pages 6.9.1 2024-05-02 catopen(3)
Pages that refer to this page: catgets(3), environ(7), locale(7)
|
HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|