usr/src/man/man9f/csx_Event2Text.9f

   1 '\" te
   2 .\"  Copyright (c) 1996, 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 CSX_EVENT2TEXT 9F "Jul 19, 1996"
   7 .SH NAME
   8 csx_Event2Text \- convert events to text strings
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBint32_t\fR \fBcsx_Event2Text\fR(\fBevent2text_t *\fR\fIev\fR);
  17 .fi
  18
  19 .SH INTERFACE LEVEL
  20 .sp
  21 .LP
  22 Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR
  23 .SH PARAMETERS
  24 .sp
  25 .ne 2
  26 .na
  27 \fB\fIev\fR\fR
  28 .ad
  29 .RS 6n
  30 Pointer to an \fBevent2text_t\fR structure.
  31 .RE
  32
  33 .SH DESCRIPTION
  34 .sp
  35 .LP
  36 This function is a Solaris-specific extension that provides a method for
  37 clients to convert Card Services events to text strings.
  38 .SH STRUCTURE MEMBERS
  39 .sp
  40 .LP
  41 The structure members of \fBevent2text_t\fR are:
  42 .sp
  43 .in +2
  44 .nf
  45 event_t     event;                        /*the event code*/
  46 char        text[CS_EVENT_MAX_BUFSIZE]    /*the event code*/
  47
  48 .fi
  49 .in -2
  50
  51 .sp
  52 .LP
  53 The fields are defined as follows:
  54 .sp
  55 .ne 2
  56 .na
  57 \fB\fBevent\fR\fR
  58 .ad
  59 .RS 9n
  60 The text for the event code in the \fBevent\fR field is returned in the
  61 \fBtext\fR field.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBtext\fR\fR
  68 .ad
  69 .RS 9n
  70 The text string describing the name of the event.
  71 .RE
  72
  73 .SH RETURN VALUES
  74 .sp
  75 .ne 2
  76 .na
  77 \fB\fBCS_SUCCESS\fR\fR
  78 .ad
  79 .RS 27n
  80 Successful operation.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fB\fBCS_UNSUPPORTED_FUNCTION\fR\fR
  87 .ad
  88 .RS 27n
  89 No \fBPCMCIA \fRhardware installed.
  90 .RE
  91
  92 .SH CONTEXT
  93 .sp
  94 .LP
  95 This function may be called from user or kernel context.
  96 .SH EXAMPLES
  97 .LP
  98 \fBExample 1 \fR: Using \fBcsx_Event2Text()\fR
  99 .sp
 100 .in +2
 101 .nf
 102 xx_event(event_t event, int priority, event_callback_args_t *eca)
 103 {
 104           event2text_t    event2text;
 105
 106           event2text.event = event;
 107           csx_Event2Text(&event2text);
 108           cmn_err(CE_CONT, "event %s (0x%x)", event2text.text, (int)event);
 109 }
 110 .fi
 111 .in -2
 112
 113 .SH SEE ALSO
 114 .sp
 115 .LP
 116 \fBcsx_event_handler\fR(9E), \fBcsx_Error2Text\fR(9F)
 117 .sp
 118 .LP
 119 \fIPC Card  95 Standard, PCMCIA/JEIDA\fR