usr/src/man/man3nsl/t_errno.3nsl

   1 '\" te
   2 .\"  Copyright 1994, The X/Open Company Ltd., All Rights Reserved. Portions Copyright 1989 AT&amp;T. Portions Copyright (c) 1998, Sun Microsystems, Inc. , All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH T_ERRNO 3NSL "April 9, 2016"
  11 .SH NAME
  12 t_errno \- XTI error return value
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <xti.h>
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .LP
  21 This error return value is part of the XTI interfaces that evolved from the TLI
  22 interfaces. XTI represents the future evolution of these interfaces. However,
  23 TLI interfaces are supported for compatibility. When using a TLI interface that
  24 has the same name as an XTI interfaces, a different headerfile,
  25 <\fBtiuser.h\fR>, must be used. Refer to the TLI COMPATIBILITY section for a
  26 description of differences between the two interfaces.
  27 .sp
  28 .LP
  29 \fBt_errno\fR is used by XTI functions to return error values.
  30 .sp
  31 .LP
  32 XTI functions provide an error number in  \fBt_errno\fR which has type
  33 \fIint\fR and is defined in  \fB<xti.h>\fR\&. The value of  \fBt_errno\fR will
  34 be defined only after a call to a XTI function for which it is explicitly
  35 stated to be set and until it is changed by the next XTI function call. The
  36 value of  \fBt_errno\fR should only be examined when it is indicated to be
  37 valid by a function's return value. Programs should obtain the definition of
  38 \fBt_errno\fR by the inclusion of  \fB<xti.h>\fR\&. The practice of defining
  39 \fBt_errno\fR in program as  \fBextern\fR \fBint\fR \fBt_errno\fR is
  40 obsolescent. No XTI function sets  \fBt_errno\fR to 0 to indicate an error.
  41 .sp
  42 .LP
  43 It is unspecified whether \fBt_errno\fR is a macro or an identifier with
  44 external linkage.  It represents a modifiable  \fBlvalue\fR of type \fIint\fR.
  45 If a macro definition is suppressed in order to access an actual object or a
  46 program defines an identifier with name  \fIt_errno\fR, the behavior is
  47 undefined.
  48 .sp
  49 .LP
  50 The symbolic values stored in  \fBt_errno\fR by an XTI function are defined in
  51 the \fBERRORS\fR sections in all relevant XTI function definition pages.
  52 .SH TLI COMPATIBILITY
  53 .LP
  54 \fBt_errno\fR is also used by TLI functions to return error values.
  55 .sp
  56 .LP
  57 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
  58 different header files. This, and other semantic differences between the two
  59 interfaces are described in the subsections below.
  60 .SS "Interface Header"
  61 .LP
  62 The \fBXTI\fR interfaces use the header file, <\fBxti.h\fR>. \fBTLI\fR
  63 interfaces should \fInot\fR use this header.  They should use the header:
  64 .br
  65 .in +2
  66 \fB#include <tiuser.h>\fR
  67 .in -2
  68 .SS "Error Description Values"
  69 .LP
  70 The \fBt_errno\fR values that can be set by the \fBXTI\fR interface but cannot
  71 be set by the \fBTLI\fR interface are:
  72 .br
  73 .in +2
  74 \fBTNOSTRUCTYPE\fR
  75 .in -2
  76 .br
  77 .in +2
  78 \fBTBADNAME\fR
  79 .in -2
  80 .br
  81 .in +2
  82 \fBTBADQLEN\fR
  83 .in -2
  84 .br
  85 .in +2
  86 \fBTADDRBUSY\fR
  87 .in -2
  88 .br
  89 .in +2
  90 \fBTINDOUT\fR
  91 .in -2
  92 .br
  93 .in +2
  94 \fBTPROVMISMATCH\fR
  95 .in -2
  96 .br
  97 .in +2
  98 \fBTRESADDR\fR
  99 .in -2
 100 .br
 101 .in +2
 102 \fBTQFULL\fR
 103 .in -2
 104 .br
 105 .in +2
 106 \fBTPROTO\fR
 107 .in -2
 108 .SH ATTRIBUTES
 109 .LP
 110 See \fBattributes\fR(5) for descriptions of the following attributes:
 111 .sp
 112
 113 .sp
 114 .TS
 115 box;
 116 c | c
 117 l | l .
 118 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 119 _
 120 MT-Level        MT-Safe
 121 .TE
 122
 123 .SH SEE ALSO
 124 .LP
 125 \fBattributes\fR(5)