NAME

error_$intro − error text database operations

Remarks

To view this manual entry via the man(1) command, use the function name shown above without the “$” character. 

DESCRIPTION

error_$() calls convert status codes into textual error messages, and include:

error_$c_get_text()
Return subsystem, module, and error texts for a status code.

error_$c_text() Return an error message for a status code. 

There is no header file for the error_$() calls.  They can be declared as follows:

extern void error_$c_get_text();
extern char *error_$c_text();

error_$() calls use the status_$t data type, which is defined in <idl/c/nbase.h>. 

Data Types

error_$() calls take as input a status code in status_$t format. 

status_$t A status code.  Most NCS calls supply their completion status in this format.  The status_$t type is defined as a structure containing a long integer:

struct status_$t {
long all;
}

However, the calls can also use status_$t as a set of bit fields.  To access the fields in a returned status code, assign the value of the status code to a union defined as follows:

typedef union {
struct {
unsigned fail : 1,
subsys : 7,
modc : 8;
shortcode;
} s;
long all;
} status_u;

all All 32 bits in the status code.  If all is equal to status_$ok, the call that supplied the status was successful. 

fail If this bit is set, the error was not within the scope of the module invoked, but occurred within a lower-level module. 

subsys This indicates the subsystem that encountered the error. 

modc This indicates the module that encountered the error. 

code This is a signed number that identifies the type of error that occurred. 

SEE ALSO

error_$c_get_text(3), error_$c_text(3). 

Hewlett-Packard Company  —  HP-UX Release 9.03: April 1994