Skip site navigation (1)Skip section navigation (2)

FreeBSD Man Pages

Man Page or Keyword Search:
Man Architecture
Apropos Keyword Search (all sections) Output format
home | help
CATOPEN(3)	       FreeBSD 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 substitu-
     tions:

     %N	  The value of the name	argument.

     %L	  The value of the LANG	environment variable or	the LC_MESSAGES	cate-
	  gory (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 deter-
     mines 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 descrip-
     tor.  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	cata-
			log, 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'').

FreeBSD	10.1		       February	12, 2005		  FreeBSD 10.1

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | SEE ALSO | STANDARDS

Want to link to this manual page? Use this URL:
<http://www.freebsd.org/cgi/man.cgi?query=catopen&manpath=FreeBSD+10.1-RELEASE>

home | help