t_error(3) [osf1 man page]
t_error(3) Library Functions Manual t_error(3) 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(): XNS4.0 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: Parameter Before Call After Call ------------------------------------- errmsg y n 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 mes- sage 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 mes- sage 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 t_error(3)
Check Out this Related Man Page
t_error(3NSL) Networking Services Library Functions t_error(3NSL) NAME
t_error - produce error message SYNOPSIS
#include <xti.h> int t_error(const char *errmsg); DESCRIPTION
This routine is part of the XTI interfaces which evolved from the TLI interfaces. XTI represents the future evolution of these interfaces. However, TLI interfaces are supported for compatibility. When using a TLI routine that has the same name as an XTI routine, the tiuser.h header file must be used. Refer to the TLI COMPATIBILITY section for a description of differences between the two interfaces. The t_error() function produces a message on the standard error output which describes the last error encountered during a call to a trans- port function. The argument string errmsg is a user-supplied error message that gives context to the error. The error message is written as follows: first (if errmsg is not a null pointer and the character pointed to be errmsg is not the null character) the string pointed to by errmsg followed by a colon and a space; then a standard error message string for the current error defined in t_errno. If t_errno has a value different from TSYSERR, the standard error message string is followed by a newline character. If, however, t_errno is equal to TSYSERR, the t_errno string is followed by the standard error message string for the current error defined in errno followed by a newline. The language for error message strings written by t_error() is that of the current locale. If it is English, the error message string describing the value in t_errno may be derived from 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(3C) function with an argument of errno. The error number, t_errno, is only set when an error occurs and it is not cleared on successful calls. EXAMPLES
If a t_connect(3NSL) function fails on transport endpoint fd2 because a bad address was given, the following call might follow the failure: t_error("t_connect failed on fd2"); The diagnostic message to be printed would look like: t_connect failed on fd2: incorrect addr format where incorrect addr format identifies the specific error that occurred, and t_connect failed on fd2 tells the user which function failed on which transport endpoint. RETURN VALUES
Upon completion, a value of 0 is returned. VALID STATES
All - apart from T_UNINIT ERRORS
No errors are defined for the t_error() function. TLI COMPATIBILITY
The XTI and TLI interface definitions have common names but use different header files. This, and other semantic differences between the two interfaces are described in the subsections below. Interface Header The XTI interfaces use the header file, xti.h. TLI interfaces should not use this header. They should use the header: #include <tiuser.h> Error Description Values The t_errno value that can be set by the XTI interface and cannot be set by the TLI interface is: TPROTO ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |MT Level |Safe | +-----------------------------+-----------------------------+ SEE ALSO
t_errno(3NSL)strerror(3C), attributes(5) SunOS 5.10 7 May 1998 t_error(3NSL)