usr/src/man/man3dlpi/dlpi_disabnotify.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_DISABNOTIFY 3DLPI "Sep 21, 2007"
   7 .SH NAME
   8 dlpi_disabnotify \- disable DLPI notification
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... -\fBldlpi\fR [ \fIlibrary\fR... ]
  13 #include <libdlpi.h>
  14
  15 \fBint\fR \fBdlpi_disabnotify\fR(\fBdlpi_handle_t\fR \fIdh\fR, \fBdlpi_notifyid_t\fR \fIid\fR,
  16      \fBvoid **\fR\fIargp\fR);
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The \fBdlpi_disabnotify()\fR function disables the notification registration
  23 associated with identifier \fIid\fR. If \fIargp\fR is not NULL, the argument
  24 \fIarg\fR that was passed to \fBdlpi_enabnotify\fR(3DLPI) during registration
  25 is also returned. This operation can be performed in any DLPI state of a
  26 handle.
  27 .sp
  28 .LP
  29 Closing the DLPI handle \fIdh\fR will also remove all associated callback
  30 functions.
  31 .SH RETURN VALUES
  32 .sp
  33 .LP
  34 Upon success, \fBDLPI_SUCCESS\fR is returned. If \fBDL_SYSERR\fR is returned,
  35 \fBerrno\fR contains the specific UNIX system error value. Otherwise, a DLPI
  36 error value defined in \fB<sys/dlpi.h>\fR or an error value listed in the
  37 following section is returned.
  38 .SH ERRORS
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fBDLPI_EINHANDLE\fR\fR
  43 .ad
  44 .RS 21n
  45 A DLPI handle is invalid.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fBDLPI_EINVAL\fR\fR
  52 .ad
  53 .RS 21n
  54 An argument is invalid.
  55 .RE
  56
  57 .sp
  58 .ne 2
  59 .na
  60 \fB\fBDLPI_ENOTEIDINVAL\fR\fR
  61 .ad
  62 .RS 21n
  63 The DLPI notification ID is invalid.
  64 .RE
  65
  66 .sp
  67 .ne 2
  68 .na
  69 \fB\fBDLPI_FAILURE\fR\fR
  70 .ad
  71 .RS 21n
  72 The DLPI operation failed.
  73 .RE
  74
  75 .SH ATTRIBUTES
  76 .sp
  77 .LP
  78 See \fBattributes\fR(5) for descriptions of the following attributes:
  79 .sp
  80
  81 .sp
  82 .TS
  83 box;
  84 c | c
  85 l | l .
  86 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  87 _
  88 Interface Stability     Committed
  89 _
  90 MT-Level        Safe
  91 .TE
  92
  93 .SH SEE ALSO
  94 .sp
  95 .LP
  96 \fBdlpi_enabnotify\fR(3DLPI), \fBlibdlpi\fR(3LIB), \fBattributes\fR(5)