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

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Portions Copyright 1989 AT&T
  44 .\" Copyright 1994, The X/Open Company Ltd.  All Rights Reserved.
  45 .\" Portions Copyright (c) 1998, Sun Microsystems, Inc.  All Rights Reserved
  46 .\"
  47 .TH T_FREE 3NSL "May 7, 1998"
  48 .SH NAME
  49 t_free \- free a library structure
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <xti.h>
  54
  55
  56
  57
  58 \fBint\fR \fBt_free\fR(\fBvoid *\fR\fIptr\fR, \fBint\fR \fIstruct_type\fR);
  59 .fi
  60
  61 .SH DESCRIPTION
  62 .sp
  63 .LP
  64 This routine is part of the \fBXTI\fR interfaces which evolved from the
  65 \fBTLI\fR interfaces. \fBXTI\fR represents the future evolution of these
  66 interfaces. However, \fBTLI\fR interfaces are supported for compatibility. When
  67 using a \fBTLI\fR routine that has the same name as an \fBXTI\fR routine, the
  68 \fBtiuser.h\fR header file must be used.  Refer to the  \fBTLI\fR
  69 \fBCOMPATIBILITY\fR section for a description of differences between the two
  70 interfaces.
  71 .sp
  72 .LP
  73 The \fBt_free()\fR function frees memory previously allocated by
  74 \fBt_alloc\fR(3NSL). This function will free memory for the specified
  75 structure, and will also free memory for buffers referenced by the structure.
  76 .sp
  77 .LP
  78 The argument \fIptr\fR points to one of the seven structure types described for
  79 \fBt_alloc\fR(3NSL), and \fIstruct_type\fR identifies the type of that
  80 structure which must be one of the following:
  81 .sp
  82 .in +2
  83 .nf
  84 T_BIND      struct      t_bind
  85 T_CALL      struct      t_call
  86 T_OPTMGMT   struct      t_optmgmt
  87 T_DIS       struct      t_discon
  88 T_UNITDATA  struct      t_unitdata
  89 T_UDERROR   struct      t_uderr
  90 T_INFO      struct      t_info
  91 .fi
  92 .in -2
  93
  94 .sp
  95 .LP
  96 where each of these structures is used as an argument to one or more transport
  97 functions.
  98 .sp
  99 .LP
 100 The function \fBt_free()\fR will check the \fIaddr\fR, \fIopt\fR and
 101 \fIudata\fR fields of the given structure, as appropriate, and free the buffers
 102 pointed to by the \fIbuf\fR field of the \fBnetbuf\fR structure. If \fIbuf\fR
 103 is a null pointer, \fBt_free()\fR will not attempt to free memory.  After all
 104 buffers are freed, \fBt_free()\fR will free the memory associated with the
 105 structure pointed to by \fIptr\fR.
 106 .sp
 107 .LP
 108 Undefined results will occur if \fIptr\fR or any of the \fIbuf\fR pointers
 109 points to a block of memory that was not previously allocated by
 110 \fBt_alloc\fR(3NSL).
 111 .SH RETURN VALUES
 112 .sp
 113 .LP
 114 Upon successful completion, a value of  \fB0\fR is returned.  Otherwise, a
 115 value of  -1 is returned and \fBt_errno\fR is set to indicate an error.
 116 .SH VALID STATES
 117 .sp
 118 .LP
 119 ALL - apart from \fBT_UNINIT\fR.
 120 .SH ERRORS
 121 .sp
 122 .LP
 123 On failure, \fBt_errno\fR is set to the following:
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBTNOSTRUCTYPE\fR\fR
 128 .ad
 129 .RS 16n
 130 Unsupported \fIstruct_type\fR requested.
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBTPROTO\fR\fR
 137 .ad
 138 .RS 16n
 139 This error indicates that a communication problem has been detected between XTI
 140 and the transport provider for which there is no other suitable XTI error
 141 \fI(t_errno)\fR.
 142 .RE
 143
 144 .sp
 145 .ne 2
 146 .na
 147 \fB\fBTSYSERR\fR\fR
 148 .ad
 149 .RS 16n
 150 A system error has occurred during execution of this function.
 151 .RE
 152
 153 .SH TLI COMPATIBILITY
 154 .sp
 155 .LP
 156 The \fBXTI\fR and \fBTLI\fR interface definitions have common names but use
 157 different header files. This, and other semantic differences between the two
 158 interfaces are described in the subsections below.
 159 .SS "Interface Header"
 160 .sp
 161 .LP
 162 The \fBXTI\fR interfaces use the header file, \fBxti.h\fR. \fBTLI\fR interfaces
 163 should \fInot\fR use this header.  They should use the header:
 164 .sp
 165 .in +2
 166 .nf
 167 #include <tiuser.h>
 168 .fi
 169 .in -2
 170
 171 .SS "Error Description Values"
 172 .sp
 173 .LP
 174 The \fBt_errno\fR value that can be set by the \fBXTI\fR interface and cannot
 175 be set by the \fBTLI\fR interface is:
 176 .sp
 177 .ne 2
 178 .na
 179 \fB\fBTPROTO\fR \fR
 180 .ad
 181 .RS 11n
 182
 183 .RE
 184
 185 .SH ATTRIBUTES
 186 .sp
 187 .LP
 188 See \fBattributes\fR(5)  for descriptions of the following attributes:
 189 .sp
 190
 191 .sp
 192 .TS
 193 box;
 194 c | c
 195 l | l .
 196 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 197 _
 198 MT Level        Safe
 199 .TE
 200
 201 .SH SEE ALSO
 202 .sp
 203 .LP
 204 \fBt_alloc\fR(3NSL), \fBattributes\fR(5)