Networking Services Library Functions terror(3NSL)
NAME
terror - produce error message
SYNOPSIS
#include
int terror(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 terror() function produces a message on the standard
error output which describes the last error encountered dur-
ing a call to a transport 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 fol-
lowed by a colon and a space; then a standard error message
string for the current error defined in terrno. If terrno
has a value different from TSYSER, the standard error mes-
sage string is followed by a newline character. If, how-
ever, terrno is equal to TSYSER, the terrno 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 terror()
is that of the current locale. If it is English, the error
message string describing the value in terrno may be
derived from the comments following the terrno 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, terrno, is only set when an error occurs
and it is not cleared on successful calls.
SunOS 5.11 Last change: 7 May 1998 1
Networking Services Library Functions terror(3NSL)
EXAMPLES
If a tconnect(3NSL) function fails on transport endpoint
fd2 because a bad address was given, the following call
might follow the failure:
terror("tconnect failed on fd2");
The diagnostic message to be printed would look like:
tconnect failed on fd2: incorrect addr format
where incorrect addr format identifies the specific error
that occurred, and tconnect 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 TUNINIT
ERORS
No errors are defined for the terror() function.
TLI COMPATIBILITY
The XTI and TLI interface definitions have common names but
use different header files. This, and other semantic differ-
ences between the two interfaces are described in the sub-
sections below.
Interface Header
The XTI interfaces use the header file, xti.h. TLI inter-
faces should not use this header. They should use the
header:
#include
Error Description Values
The terrno value that can be set by the XTI interface and
cannot be set by the TLI interface is:
TPROTO
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
SunOS 5.11 Last change: 7 May 1998 2
Networking Services Library Functions terror(3NSL)
ATRIBUTE TYPE ATRIBUTE VALUE
MT Level Safe
SEE ALSO
terrno(3NSL)strerror(3C), attributes(5)
SunOS 5.11 Last change: 7 May 1998 3
|