share/man/man9f/ldi_ev_get_type.9f

   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 LDI_EV_GET_TYPE 9F "Aug 21, 2007"
   7 .SH NAME
   8 ldi_ev_get_type \- get event name string from event cookie
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/sunldi.h>
  13
  14 \fBint\fR \fBldi_ev_get_type\fR(\fIldi_ev_cookie_t cookie\fR);
  15 .fi
  16
  17 .SH INTERFACE LEVEL
  18 .sp
  19 .LP
  20 Solaris DDI specific (Solaris DDI)
  21 .SH PARAMETERS
  22 .sp
  23 .ne 2
  24 .na
  25 \fB\fIldi_ev_cookie_t cookie\fR\fR
  26 .ad
  27 .sp .6
  28 .RS 4n
  29 An opaque event cookie for the event type returned by a previous call to
  30 \fBldi_ev_get_cookie\fR(9F).
  31 .RE
  32
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 The \fBldi_ev_get_type()\fR function returns the event string represented by
  37 the \fBLDI\fR event cookie "\fBcookie\fR".
  38 .SH RETURN VALUES
  39 .sp
  40 .LP
  41 On success, this function returns the event string represented by
  42 "\fBcookie\fR". On failure, this function returns \fBNULL\fR.
  43 .SH CONTEXT
  44 .sp
  45 .LP
  46 This function can be called from user and kernel contexts only.
  47 .SH SEE ALSO
  48 .sp
  49 .LP
  50 \fBldi_ev_get_cookie\fR(9F), \fBldi_ev_register_callbacks\fR(9F),
  51 \fBldi_ev_remove_callbacks\fR(9F)