t_error(3)                                                   t_error(3)

  t_error()

  NAME

    t_error - produce error message

  SYNOPSIS

    #include 

    int t_error(
        const char *errmsg)

  DESCRIPTION

    The t_error(3) function produces a message on the standard error output
    which describes the last error encountered during a call to a transport
    function. The argument string errmsg is a user-supplied error message that
    gives context to the error.

    Parameters     Before call     After call

    errmsg         x               =

    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(3) 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 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.

  EXAMPLE

    If a t_connect(3) 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.

  VALID STATES

    All - apart from T_UNINIT

  ERRORS

    No errors are defined for the t_error(3) function.

  RETURN VALUE

    Upon completion, a value of 0 is returned.

  USAGE NOTES

    The t_error function is not thread safe.

    The t_error function is not async-signal safe.