share/man/man9f/ddi_remove_event_handler.9f

   1 '\" te
   2 .\"  Copyright (c) 2003, 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 DDI_REMOVE_EVENT_HANDLER 9F "May 2, 2003"
   7 .SH NAME
   8 ddi_remove_event_handler \- remove an NDI event service callback handler
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/dditypes.h>
  13 #include <sys/sunddi.h>
  14
  15 \fBint\fR \fBddi_remove_event_handler\fR(\fBddi_registration_id_t\fR \fIid\fR);
  16 .fi
  17
  18 .SH INTERFACE LEVEL
  19 .sp
  20 .LP
  21 Solaris DDI specific (Solaris DDI).
  22 .SH PARAMETERS
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fBddi_registration_id_t \fR\fIid\fR\fR
  27 .ad
  28 .RS 28n
  29 Unique system wide registration ID return by \fBddi_add_event_handler\fR(9F)
  30 upon successful registration.
  31 .RE
  32
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 The \fBddi_remove_event_handler()\fR function removes the callback handler
  37 specified by the registration \fIid\fR (\fBddi_registration_id_t\fR). Upon
  38 successful removal, the callback handler is removed from the system and will
  39 not be invoked in the face of the event.
  40 .SH RETURN VALUES
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fBDDI_SUCCESS\fR\fR
  45 .ad
  46 .RS 15n
  47 Callback handler removed successfully.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fBDDI_FAILURE\fR\fR
  54 .ad
  55 .RS 15n
  56 Failed to remove callback handler.
  57 .RE
  58
  59 .SH CONTEXT
  60 .sp
  61 .LP
  62 The \fBddi_remove_event_handler()\fR function can be called from user and
  63 kernel contexts only.
  64 .SH ATTRIBUTES
  65 .sp
  66 .LP
  67 See \fBattributes\fR(5) for a description of the following attributes:
  68 .sp
  69
  70 .sp
  71 .TS
  72 box;
  73 c | c
  74 l | l .
  75 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  76 _
  77 Stability Level Committed
  78 .TE
  79
  80 .SH SEE ALSO
  81 .sp
  82 .LP
  83 \fBattributes\fR(5), \fBddi_add_event_handler\fR(9F),
  84 \fBddi_get_eventcookie\fR(9F)
  85 .sp
  86 .LP
  87 \fIWriting Device Drivers\fR
  88 .SH NOTES
  89 .sp
  90 .LP
  91 Device drivers must remove all registered callback handlers before
  92 \fBdetach\fR(9E) processing for that device instance is complete.