Closes a message catalog.

Format

#include <nl_types.h>

int catclose (nl_catd catd);

Arguments

catd

A message catalog descriptor. This is returned by a successful call to catopen.

Description

This function closes the message catalog referenced by catd and frees the catalog file descriptor.

Return Values

0	Indicates that the catalog was successfully closed.
--1	Indicates that an error occurred. The function sets errno to the following value: EBADF -- The catalog descriptor is not valid.

Retrieves a message from a message catalog.

Format

#include <nl_types.h>

char *catgets (nl_catd catd, int set_id, int msg_id, const char *s);

Arguments

catd

A message catalog descriptor. This is returned by a successful call to catopen.

set_id

An integer set identifier.

msg_id

An integer message identifier.

s

A pointer to a default message string that is returned by the function if the message cannot be retrieved.

Description

This function retrieves a message identified by set_id and msg_id, in the message catalog catd. The message is stored in a message buffer in the nl_catd structure, which is overwritten by subsequent calls to catgets. If a message string needs to be preserved, it should be copied to another location by the program.

Return Values

x

Pointer to the retrieved message.

s

Pointer to the default message string. Indicates that the function is not able to retrieve the requested message from the catalogue. This condition can arise if the requested pair ( set_d, msg_id) does not represent an existing message from the open catalogue, or it indicates that an error occurred. If an error occurred, the function sets errno to one of the following values: EBADF -- The catalog descriptor is not valid. EVMSRR -- A VMS I/O read error; the VMS error code can be found in vaxc$errno .

Example

#include <nl_types.h> #include <locale.h> #include <stdarg.h> #include <stdio.h> #include <stdlib.h> #include <unixio.h> /* This test makes use of all the message catalog routines. catopen() */ /* opens the catalog ready for reading, then each of the three */ /* messages in the catalog are extracted in turn using catgets() and */ /* printed out. catclose() closes the catalog after use. */ /* The catalog source file used to create the catalog is as follows: */ /* $ this is a message file * $ * $quote " * $ another comment line * $set 1 * 1 "First set, first message" * 2 "second message - This long message uses a backslash \ * for continuation." * $set 2 * 1 "Second set, first message" */ char *default_msg = "this is the first message."; main() { nl_catd catalog; int msg1, msg2, retval; char *cat = "sys$disk:[]catgets_example.cat"; /*Force local catalog*/ char *msgtxt; char string[128]; /* Create the message test catalog */ system("gencat catgets_example.msgx catgets_example.cat") ; if ((catalog = catopen(cat, 0)) == (nl_catd) - 1) { perror("catopen"); exit(EXIT_FAILURE); } msgtxt = catgets(catalog, 1, 1, default_msg); printf("%s\n", msgtxt); msgtxt = catgets(catalog, 1, 2, default_msg); printf("%s\n", msgtxt); msgtxt = catgets(catalog, 2, 1, default_msg); printf("%s\n", msgtxt); if ((retval = catclose(catalog)) == -1) { perror("catclose"); exit(EXIT_FAILURE); } delete("catgets_example.cat;") ; /* Remove the test catalog */ }

Running the example program produces the following result:

First set, first message second message - This long message uses a backslash for continuation. Second set, first message

Opens a message catalog.

Format

#include <nl_types.h>

nl_catd catopen (const char *name, int oflag);

Arguments

name

The name of the message catalog to open.

oflag

An object of type int that determines whether the locale set for the LC_MESSAGES category in the current program's locale or the logical name LANG is used to search for the catalog file.

Description

This function opens the message catalog identified by name.

If name contains a colon (:), a square opening bracket ([), or an angle bracket (<), or is defined as a logical name, then it is assumed that name is the complete file specification of the catalog.

If it does not include these characters, catopen assumes that name is a logical name pointing to an existing catalog file. If name is not a logical name, then the logical name NLSPATH is used to define the file specification of the message catalog. NLSPATH is defined in the user's process. If the NLSPATH logical name is not defined, or no message catalog can be opened in any of the components specified by the NLSPATH, then the SYS$NLSPATH logical name is used to search for a message catalog file.

Both NLSPATH and SYS$NLSPATH is a comma-separated list of templates. The catopen function uses each template to construct a file specification. For example, NLSPATH could be defined as:

DEFINE NLSPATH SYS$SYSROOT:[SYS$I18N.MSG]%N.CAT,SYS$COMMON:[SYSMSG]%N.CAT

In this example, catopen first searches the directory SYS$SYSROOT:[SYS$I18N.MSG] for the named catalog. If the named catalog is not found there, the directory SYS$COMMON:[SYSMSG] is searced. The catalog name is constructed by substituting %N with the name passed to catopen , and adding the .cat suffix. %N is known as a substitution field. The following substitution fields are valid:

Field	Meaning
%N	Substitute the name passed to catopen
%L 1	Substitute the locale name. The period (.) and at-sign (@) characters in the locale name are replaced by an underscore (_) character. For example, the "zh_CN.dechanzi@radical" locale name results in a substitution of ZH_CN_DECHANZI_RADICAL.
%l 1	Substitute the language part of the locale name. For example, the language part of the en_GB.ISO8859-1 locale name is en.
%t 1	Substitute the territory part of the locale name. For example, the territory part of the en_GB.ISO8859-1 locale is GB.
%c 1	Substitute the codeset name from the locale name. For example, the codeset name of the en_GB.ISO8859-1 locale name is ISO8859-1.

If the oflag argument is set to NL_CAT_LOCALE, then the current locale as defined for the LC_MESSAGES category is used to determine the substitution for the %L, %l, %t, and %c substitution fields. If the oflag argument is set to 0, then the value of the LANG environment variable is used as a locale name to determine the substitution for these fields. Note that using NL_CAT_LOCALE conforms to the XPG4 specification while a value of 0 (zero) exists for the purpose of preserving XPG3 compatibility. Note also, that catopen uses the value of the LANG environment variable without checking whether the program's locale can be set using this value. That is, catopen does not check whether this value can serve as a valid locale argument in the setlocale call.

If the substitution value is not defined, an empty string is substituted.

A leading comma or two adjacent commas (,,) is equivalent to specifying %N. For example,

DEFINE NLSPATH ",%N.CAT,SYS$COMMON:[SYSMSG.%L]%N.CAT"

In this example, catopen searches in the following locations in the order shown:

1. name (in the current directory)
2. name.cat (in the current directory)
3. SYS$COMMON:[SYSMSG.locale_name]name.cat

Return Values

x

A message catalog file descriptor. Indicates the call was successful. This descriptor is used in calls to catgets and catclose .

(nl_catd) --1

Indicates an error occurred. The function sets errno to one of the following values: EACCES -- Insufficient privilege or file protection violation, or file currently locked by another user. EMFILE -- Process channel count exceeded. ENAMETOOLONG -- The full file specification for message catalogue is too long ENOENT -- Unable to find the requested message catalogue. ENOMEM -- Insufficient memory available. ENOTDIR -- Part of the name argument is not a valid directory. EVMSERR -- An error occurred that does not match any errno value. Check the value of vaxc$errno .

Returns the rounded cube root of y.

Format

#include <math.h>

double cbrt (double y);

float cbrtf (float y);

long double cbrtl (long double y);

Arguments

y

A real number.

Returns the smallest integer that is greater than or equal to its argument.

Format

#include <math.h>

double ceil (double x);

float ceilf (float x); (ALPHA ONLY)

long double ceill (long double x); (ALPHA ONLY)

Argument

x

A real value.

Return Values

n	The smallest integer greater than or equal to the function argument.

Makes available for reallocation the area allocated by a previous calloc , malloc , or realloc call. This function is AST-reentrant.

Format

#include <stdlib.h>

void cfree (void *ptr);

Argument

ptr

The address returned by a previous call to malloc , calloc , or realloc .

Description

The contents of the deallocated area are unchanged.

In Compaq C for OpenVMS Systems, the free and cfree functions are equivalent. Some other C implementations use free with malloc or realloc , and cfree with calloc . However, since the ANSI C standard does not include cfree , using free may be preferable.

See also free in this section.

Changes the default directory.

Format

#include <unistd.h>

int chdir (const char *dir_spec); (ISO POSIX-1)

int chdir (const char *dir_spec, ...); (COMPAQ C EXTENSION)

Argument

dir_spec

A null-terminated character string naming a directory in either an OpenVMS or UNIX style specification.

...

This argument is a Compaq C extension available when not defining any of the standards-related feature-test macros (see Section 1.5 and not compiling in strict ANSI C mode (/STANDARD=ANSI89). The argument is an optional flag of type int that is significant only when calling chdir from USER mode.

If the value of the flag is 1, the new directory is effective across images. If the value is not 1, the original default directory is restored when the image exits.

Description

This function changes the default directory. The change can be permanent or temporary. Permanent means that the new directory remains as the default directory after the image exits. Temporary means that on image exit, the default is set to whatever it was before the execution of the image.

There are two ways of making the change permanent:

• Call chdir from USER mode with the second argument set to 1.
• Call chdir from SUPERVISOR or EXECUTIVE mode, regardless of the value of the second argument.

Otherwise, the change is temporary.

Return Values

0	Indicates that the directory is successfully changed to the given name.
--1	Indicates that the change attempt has failed.

Changes the file protection of a file.

Format

#include <stat.h>

int chmod (const char *file_spec, mode_t mode);

Arguments

file_spec

The name of an OpenVMS or UNIX style file specification.

mode

A file protection. Modes are constructed by performing a bitwise OR on any of the values shown in Table REF-2.

Table REF-2 File Protection Values and Their Meanings

Value	Privilege
0400	OWNER:READ
0200	OWNER:WRITE
0100	OWNER:EXECUTE
0040	GROUP:READ
0020	GROUP:WRITE
0010	GROUP:EXECUTE
0004	WORLD:READ
0002	WORLD:WRITE
0001	WORLD:EXECUTE

When you supply a mode value of 0, the chmod function gives the file the user's default file protection.

The system is given the same privileges as the owner. A WRITE privilege also implies a DELETE privilege.

Description

You must have a WRITE privilege for the file specified to change the mode.

Return Values

0	Indicates that the mode is successfully changed.
--1	Indicates that the change attempt has failed.

Changes the owner user identification code (UIC) of the file.

Format

#include <unistd.h>

int chown (const char *file_spec, uid_t owner, gid_t group);

Arguments

file_spec

The address of an ASCII file name.

owner

An integer corresponding to the new owner UIC of the file.

group

An integer corresponding to the group UIC of the file.

Return Values

0	Indicates success.
--1	Indicates failure.

Erase the contents of the specified window and reset the cursor to coordinates (0,0). The clear function acts on the stdscr window.

Format

#include <curses.h>

int clear();

int wclear (WINDOW *win);

Argument

win

A pointer to the window.

Return Values

OK	Indicates success.
ERR	Indicates an error.

Resets the error and end-of-file indicators for a file (so that ferror and feof will not return a nonzero value).

Format

#include <stdio.h>

void clearerr (FILE *file_ptr);

Argument

file_ptr

A file pointer.

Sets the clear flag for the window.

Format

#include <curses.h>

clearok (WINDOW *win, bool boolf);

Arguments

win

The entire size of the terminal screen. You can use the windows stdscr and curscr with clearok .

boolf

A Boolean value of TRUE or FALSE. If the argument is TRUE, this forces a clearscreen to be printed on the next call to refresh , or stops the screen from being cleared if boolf is FALSE.

The type bool is defined in the <curses.h> header file as follows:

#define bool int

Description

Unlike the clear function, the clearok function does not alter the contents of the window. If the win argument is curscr , the next call to refresh causes a clearscreen, even if the window passed to refresh is not a window the size of the entire terminal screen.

Determines the CPU time (in 10-millisecond units) used since the beginning of the process. The time reported is the sum of the user and system times of the calling process and any terminated child processes for which the calling process has executed wait or system .

Format

#include <time.h>

clock_t clock (void);

Description

The value returned by the clock function must be divided by the value of the CLK_TCK, as defined in the standard header file <time.h> , to obtain the time in seconds.

The type clock_t is defined in the <time.h> header file as follows:

typedef long int clock_t;

Only the accumulated times for child processes running a C main program or a program that calls VAXC$CRTL_INIT or DECC$CRTL_INIT are included.

A typical usage of the clock function is to call it after a program does its initial setup, and then again after the program executes the code to be timed. Then subtract the two values to give elapsed CPU time.

Return Values

n	The processor time used.
--1	Indicates that the processor time used is not available.