ZCOMERROR (3X)

NAME

zcomerror - Return a formatted ZCOM error message

SYNOPSIS

#include  <zcom/zcomsys.h>
#include  <zcom/zcomcall.h> /* if compiled with ANSI C (recommended) */
 
char      *zcomerror(err)
int32     err;

Description

Routine zcomerror returns a character string containing error text associated with an error number returned through use of the ZCOM library calls. It works in a similar fashion to zcomstatus, however, it has only one parameter passed in the call.

The return character string can be up to 31 bytes in length, plus a terminating zero.

The libraries libzcom_c.a and libpthread.a must be linked into the calling program by giving the options “-lzcom_c -lpthread” to cc(1) or ld(1).

Threads Considerations

This routine may be called from a multi-threaded application using the POSIX (1003.1c) kernel threads API package. This routine has the following characteristics when called by a multi-threaded application:

not a cancellation point	Thread cancellation will not occur when a thread is calling this routine.
async-cancel unsafe	The calling thread’s cancelability type must be PTHREAD_CANCEL_DEFERRED if cancellation is enabled.
async-signal unsafe	It cannot be called from a signal handler.
fork unsafe	It cannot be called by a child process after fork(2) but before exec(2).

PARAMETERS

err

Error number.

NOTES

This routine reads a message file for the error message text. It uses the file zerrmsg.msg in /opt/acc/msg (ZCOM_MESSAGE_PATH). If not found, it uses the default message file default.msg.

RETURN VALUE

Routine zcomerror returns a character string corresponding to the error number passed in as a parameter (err).

EXAMPLE

#include    <zcom/zcomsys.h>
#include    <zcom/zcomcall.h>
 
char        *errmsg;  /* Returned message string */
int32       err;
 
errmsg = zcomerror (err);

FILES

/opt/acc/include/zcom/zcomsys.h	ZCOM subsystem general include file, containing data types, data structures, constants, error codes, masks, etc. Note that this must be the first include file before any other ZCOM include files.
/opt/acc/include/zcom/zcomcall.h	ZCOM routine function prototypes (requires ANSI C compilation).
/opt/acc/msg/zstatmsg.msg	ZCOM status messages.
/opt/acc/msg/default.msg	Master message text file.