svcadm(8)을 검색하려면 섹션에서 8 을 선택하고, 맨 페이지 이름에 svcadm을 입력하고 검색을 누른다.
catclose(3c)
catopen(3C) Standard C Library Functions catopen(3C)
NAME
catopen, catclose - open/close a message catalog
SYNOPSIS
#include <nl_types.h>
nl_catd catopen(const char *name, int oflag);
int catclose(nl_catd catd);
DESCRIPTION
The catopen() function opens a message catalog and returns a message
catalog descriptor. name specifies the name of the message catalog to
be opened. If name contains a "/", then name specifies a complete path‐
name for the message catalog; otherwise, the environment variable
NLSPATH is used and /usr/lib/locale/locale/LC_MESSAGES must exist. If
NLSPATH does not exist in the environment, or if a message catalog can‐
not be opened in any of the paths specified by NLSPATH, then the de‐
fault path /usr/lib/locale/locale/LC_MESSAGES is used. In the "C" lo‐
cale, catopen() will always succeed without checking the default search
path.
The names of message catalogs and their location in the filesystem can
vary from one system to another. Individual applications can choose to
name or locate message catalogs according to their own special needs. A
mechanism is therefore required to specify where the catalog resides.
The NLSPATH variable provides both the location of message catalogs, in
the form of a search path, and the naming conventions associated with
message catalog files. For example:
NLSPATH=/nlslib/%L/%N.cat:/nlslib/%N/%L
The metacharacter % introduces a substitution field, where %L substi‐
tutes the current setting of either the LANG environment variable, if
the value of oflag is 0, or the LC_MESSAGES category, if the value of
oflag is NL_CAT_LOCALE, and %N substitutes the value of the name para‐
meter passed to catopen(). Thus, in the above example, catopen() will
search in /nlslib/$LANG/name.cat, if oflag is 0, or in /nlslib/{LC_MES‐
SAGES}/name.cat, if oflag is NL_CAT_LOCALE.
The NLSPATH variable will normally be set up on a system wide basis (in
/etc/profile) and thus makes the location and naming conventions asso‐
ciated with message catalogs transparent to both programs and users.
The full set of metacharacters is:
%N The value of the name parameter passed to catopen().
%L The value of LANG or LC_MESSAGES.
%l The value of the language element of LANG or LC_MESSAGES.
%t The value of the territory element of LANG or LC_MESSAGES.
%c The value of the codeset element of LANG or LC_MESSAGES.
%% A single %.
The LANG environment variable provides the ability to specify the
user's requirements for native languages, local customs and character
set, as an ASCII string in the form
LANG=language_territory.codeset[@modifier]
A user who speaks German as it is spoken in Austria and has a terminal
which operates in UTF-8 codeset, would want the setting of the LANG
variable to be
LANG=de_AT.UTF-8
With this setting it should be possible for that user to find any rele‐
vant catalogs should they exist.
Should the LANG variable not be set, the value of LC_MESSAGES as re‐
turned by setlocale() is used. If this is NULL, the default path as de‐
fined in <nl_types.h> is used.
A message catalogue descriptor remains valid in a process until that
process closes it, or a successful call to one of the exec functions. A
change in the setting of the LC_MESSAGES category may invalidate exist‐
ing open catalogues.
If a file descriptor is used to implement message catalogue descrip‐
tors, the FD_CLOEXEC flag will be set; see <fcntl.h>.
If the value of oflag argument is 0, the LANG environment variable is
used to locate the catalogue without regard to the LC_MESSAGES cate‐
gory. If the oflag argument is NL_CAT_LOCALE, the LC_MESSAGES category
is used to locate the message catalogue.
If the value of LANG or LC_MESSAGES that is used in the process of lo‐
cating message catalog is a canonical locale name to obsoleted Solaris
locale names as described in locale_alias(7) and the above mentioned
ordinary locations with the value do not yield a message catalog, for a
better backward compatibility, catopen() additionally looks for its
message catalog using the obsoleted Solaris locale names as the addi‐
tional locale names to check on with in place of the value.
If the value of LANG or LC_MESSAGES that is used in the process of lo‐
cating message catalog is an accepted and supported locale name alias
to a canonical locale name that is supported as described in lo‐
cale_alias(7) and the above mentioned ordinary locations with the value
do not yield a message catalog, catopen() additionally looks for its
message catalog using the canonical locale name.
The catclose() function closes the message catalog identified by catd.
If a file descriptor is used to implement the type nl_catd, that file
descriptor will be closed. Pointers returned by calls to catgets(3C)
using a given catalog will be invalid after the associated nl_catd is
passed to catclose().
RETURN VALUES
Upon successful completion, catopen() returns a message catalog de‐
scriptor for use on subsequent calls to catgets() and catclose(). Oth‐
erwise it returns (nl_catd) −1.
Upon successful completion, catclose() returns 0. Otherwise it returns
−1 and sets errno to indicate the error.
ERRORS
The catopen() function may fail if:
EACCES Search permission is denied for the component of the
path prefix of the message catalogue or read permission
is denied for the message catalogue.
EMFILE There are OPEN_MAX file descriptors currently open in
the calling process.
ENAMETOOLONG The length of the pathname of the message catalogue ex‐
ceeds PATH_MAX, or a pathname component is longer than
NAME_MAX.
ENAMETOOLONG Pathname resolution of a symbolic link produced an in‐
termediate result whose length exceeds PATH_MAX.
ENFILE Too many files are currently open in the system.
ENOENT The message catalogue does not exist or the name argu‐
ment points to an empty string.
ENOMEM Insufficient storage space is available.
ENOTDIR A component of the path prefix of the message catalogue
is not a directory.
The catclose() function may fail if:
EBADF The catalogue descriptor is not valid.
EINTR The catclose() function was interrupted by a signal.
USAGE
The catgets() APIs defined by the X/Open standard are provided to sup‐
port historical use, and to support software requiring strict compli‐
ance with XPG7 and older standards. Otherwise, the use of the more mod‐
ern and widely supported gettext() APIs and tools is recommended.
The textdomain(3C) function is the gettext replacement for the
catopen() function.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
tab() box; cw(2.75i) |cw(2.75i) lw(2.75i) |lw(2.75i) ATTRIBUTE TYPEAT‐
TRIBUTE VALUE _ Interface StabilityCommitted _ MT-LevelMT-Safe _ Stan‐
dardSee standards(7).
MT-Level
The catopen() function can be used safely in multithreaded applica‐
tions, as long as setlocale(3C) is not being called to change the lo‐
cale.
The catclose() function can be used safely in multithreaded applica‐
tions, as long as catgets(3C) is not being called with the same nl_catd
descriptor.
SEE ALSO
gencat(1), catgets(3C), gettext(3C), setlocale(3C), nl_types.h(3HEAD),
attributes(7), environ(7), locale_alias(7)
X/Open catgets APIs in Internationalizing and Localizing Applications
in Oracle Solaris
HISTORY
The catopen() and catclose() functions have been included in all Sun
and Oracle releases of Solaris.
Oracle Solaris 11.4 25 Nov 2024 catopen(3C)