Content-type: text/html Man page of t_error

t_error

Section: C Library Functions (3)
Index Return to Main Contents
 

NAME

t_error - Produces error message  

LIBRARY

XTI Library (libxti.a)  

SYNOPSIS

#include <xti.h>

int t_error(

  char *errmsg) ;
  extern char *t_errlist[] ;
  extern int t_nerr ;
 

STANDARDS

Interfaces documented on this reference page conform to industry standards as follows:

t_error: XPG4-UNIX

Refer to the standards(5) reference page for more information about industry standards and associated tags.  

PARAMETERS

The following table summarizes the relevance of input parameter data before and after t_error() is called:

ParameterBefore CallAfter Call

errmsgyn
Notes to table:

y    This is a meaningful parameter.
n    This is not a meaningful parameter.
errmsg
Points to a user-supplied error message character string that lends proper context to the nature of the detected error.

 

VALID STATES

The t_errno() function can be called in any transport provider state except T_UNINIT.  

DESCRIPTION

The t_error() function is a general utility function used to produce an error message on the standard error output device. The error message describes the last error encountered during execution of an XTI function. The user-supplied error message is printed, followed by a colon and a standard error message for the current error defined in t_errno. When t_errno is [TSYSERR], t_error() also prints a standard error message for the current value contained in errno. The error number, t_errno, is set only when an error occurs and is not cleared when XTI functions execute successfully.

The language for error message strings written by t_error() is defined by the implementation. If it is English, the error message string describing the value in t_errno is identical to the comments following the t_errno codes defined in xti.h. The contents of the error message strings describing the value in errno are the same as those returned by the strerror(3) function with an argument of errno.

To simplify variant formatting of messages, the array of message strings named t_errlist is specified. Variable t_errno may be used as an index into this table to get a relevant message string without an ending newline character. External variable t_nerr specifies the maximum number of messages in the t_errlist table.  

RETURN VALUE

Upon successful completion, a value of 0 (zero) is returned.  

ERRORS

No errors are defined for the t_errno() function.  

RELATED INFORMATION

Functions: t_accept(3), t_alloc(3), t_bind(3), t_close(3), t_connect(3), t_free(3), t_getinfo(3), t_getstate(3), t_listen(3), t_look(3), t_open(3), t_optmgmt(3), t_rcv(3), t_rcvconnect(3), t_rcvdis(3), t_rcvrel(3), t_rcvudata(3), t_rcvuderr(3), t_snd(3), t_snddis(3), t_sndrel(3), t_sndudata(3), t_sync(3), t_unbind(3) delim off


 

Index

NAME
LIBRARY
SYNOPSIS
STANDARDS
PARAMETERS
VALID STATES
DESCRIPTION
RETURN VALUE
ERRORS
RELATED INFORMATION

This document was created by man2html, using the manual pages.
Time: 02:40:48 GMT, October 02, 2010