share/man/man3dlpi/dlpi_unbind.3dlpi

   1 '\" te
   2 .\"  Copyright (c) 2007, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" 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.
   4 .\" 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.
   5 .\" 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]
   6 .TH DLPI_UNBIND 3DLPI "Aug 22, 2007"
   7 .SH NAME
   8 dlpi_unbind \- unbind DLPI handle
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR ... ] \fIfile\fR ... \fB-ldlpi\fR [ \fIlibrary\fR ... ]
  13 #include <libdlpi.h>
  14
  15 \fBint\fR \fBdlpi_unbind\fR(\fBdlpi_handle_t\fR \fIdh\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBdlpi_unbind()\fR function unbinds to bind the \fBDLPI\fR handle \fIdh\fR
  22 from the bound \fBSAP\fR. The handle must be in the \fBDL_IDLE\fR \fBDLPI\fR
  23 state and upon success, the handle transitions to the \fBDL_UNBOUND\fR state.
  24 .sp
  25 .LP
  26 Upon success, the caller will no longer be able to send or receive data using
  27 the \fBDLPI\fR link associated with \fIdh\fR.
  28 .SH RETURN VALUES
  29 .sp
  30 .LP
  31 Upon success, \fBDLPI_SUCCESS\fR is returned. If \fBDL_SYSERR\fR is returned,
  32 \fBerrno\fR contains the specific UNIX system error value. Otherwise, a
  33 \fBDLPI\fR error value defined in \fB<sys/dlpi.h>\fR or an error value
  34 \fBDLPI_ETIMEDOUT\fR will be returned.
  35 .SH ERRORS
  36 .sp
  37 .ne 2
  38 .na
  39 \fB\fBDLPI_EBADMSG\fR\fR
  40 .ad
  41 .RS 18n
  42 Bad DLPI message
  43 .RE
  44
  45 .sp
  46 .ne 2
  47 .na
  48 \fB\fBDLPI_EINHANDLE\fR\fR
  49 .ad
  50 .RS 18n
  51 Invalid DLPI handle
  52 .RE
  53
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBDLPI_ETIMEDOUT\fR\fR
  58 .ad
  59 .RS 18n
  60 \fBDLPI\fR operation timed out
  61 .RE
  62
  63 .SH ATTRIBUTES
  64 .sp
  65 .LP
  66 See \fBattributes\fR(5) for description of the following attributes:
  67 .sp
  68
  69 .sp
  70 .TS
  71 box;
  72 c | c
  73 l | l .
  74 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  75 _
  76 Interface Stability     Committed
  77 _
  78 MT-Level        Safe
  79 .TE
  80
  81 .SH SEE ALSO
  82 .sp
  83 .LP
  84 \fBdlpi_bind\fR(3DLPI), \fBlibdlpi\fR(3LIB), \fBattributes\fR(5)