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

   1 '\" te
   2 .\"  Copyright (c) 1997, 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_GETFIRSTCLIENT 9F "May 16, 1997"
   7 .SH NAME
   8 csx_GetFirstClient, csx_GetNextClient \- return first or next client
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/pccard.h>
  13
  14
  15
  16 \fBint32_t\fR \fBcsx_GetFirstClient\fR(\fBget_firstnext_client_t *\fR\fIfnc\fR);
  17 .fi
  18
  19 .LP
  20 .nf
  21 \fBint32_t\fR \fBcsx_GetNextClient\fR(\fBget_firstnext_client_t *\fR\fIfnc\fR);
  22 .fi
  23
  24 .SH INTERFACE LEVEL
  25 .sp
  26 .LP
  27 Solaris \fBDDI \fRSpecific (Solaris \fBDDI) \fR
  28 .SH PARAMETERS
  29 .sp
  30 .ne 2
  31 .na
  32 \fB\fIfnc\fR \fR
  33 .ad
  34 .RS 8n
  35 Pointer to a \fBget_firstnext_client_t\fR structure.
  36 .RE
  37
  38 .SH DESCRIPTION
  39 .sp
  40 .LP
  41 The functions \fBcsx_GetFirstClient()\fR and \fBcsx_GetNextClient()\fR return
  42 information about the first or subsequent \fBPC \fRcards, respectively, that
  43 are installed in the system.
  44 .SH STRUCTURE MEMBERS
  45 .sp
  46 .LP
  47 The structure members of \fBget_firstnext_client_t\fR are:
  48 .sp
  49 .in +2
  50 .nf
  51 uint32_t          Socket;          /* socket number */
  52 uint32_t          Attributes;      /* attributes */
  53 client_handle_t   client_handle;   /* client handle */
  54 uint32_t          num_clients;     /* number of clients */
  55 .fi
  56 .in -2
  57
  58 .sp
  59 .LP
  60 The fields are defined as follows:
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBSocket\fR \fR
  65 .ad
  66 .RS 18n
  67 If the \fBCS_GET_FIRSTNEXT_CLIENT_SOCKET_ONLY\fR attribute is set, return
  68 information only on the  \fBPC \fRcard installed in this socket.
  69 .RE
  70
  71 .sp
  72 .ne 2
  73 .na
  74 \fB\fBAttributes\fR \fR
  75 .ad
  76 .RS 18n
  77 This field indicates the type of client. The field is bit-mapped; the following
  78 bits are defined:
  79 .sp
  80 .ne 2
  81 .na
  82 \fBCS_GET_FIRSTNEXT_CLIENT_ALL_CLIENTS\fR
  83 .ad
  84 .sp .6
  85 .RS 4n
  86 Return information on all clients.
  87 .RE
  88
  89 .sp
  90 .ne 2
  91 .na
  92 \fBCS_GET_FIRSTNEXT_CLIENT_SOCKET_ONLY\fR
  93 .ad
  94 .sp .6
  95 .RS 4n
  96 Return client information for the specified socket only.
  97 .RE
  98
  99 .RE
 100
 101 .sp
 102 .ne 2
 103 .na
 104 \fB\fBclient_handle\fR \fR
 105 .ad
 106 .RS 18n
 107 The client handle of the \fBPC \fRcard driver is returned in this field.
 108 .RE
 109
 110 .sp
 111 .ne 2
 112 .na
 113 \fB\fBnum_clients\fR \fR
 114 .ad
 115 .RS 18n
 116 The number of clients is returned in this field.
 117 .RE
 118
 119 .SH RETURN VALUES
 120 .sp
 121 .ne 2
 122 .na
 123 \fB\fBCS_SUCCESS\fR \fR
 124 .ad
 125 .RS 28n
 126 Successful operation.
 127 .RE
 128
 129 .sp
 130 .ne 2
 131 .na
 132 \fB\fBCS_BAD_HANDLE\fR \fR
 133 .ad
 134 .RS 28n
 135 Client handle is invalid.
 136 .RE
 137
 138 .sp
 139 .ne 2
 140 .na
 141 \fB\fBCS_BAD_SOCKET\fR \fR
 142 .ad
 143 .RS 28n
 144 Socket number is invalid.
 145 .RE
 146
 147 .sp
 148 .ne 2
 149 .na
 150 \fB\fBCS_NO_CARD\fR \fR
 151 .ad
 152 .RS 28n
 153 No \fBPC \fRCard in socket.
 154 .RE
 155
 156 .sp
 157 .ne 2
 158 .na
 159 \fB\fBCS_NO_MORE_ITEMS\fR \fR
 160 .ad
 161 .RS 28n
 162 \fBPC \fRCard driver does not handle the \fBCS_EVENT_CLIENT_INFO\fR event.
 163 .RE
 164
 165 .sp
 166 .ne 2
 167 .na
 168 \fB\fBCS_UNSUPPORTED_FUNCTION\fR \fR
 169 .ad
 170 .RS 28n
 171 No \fBPCMCIA \fRhardware installed.
 172 .RE
 173
 174 .SH CONTEXT
 175 .sp
 176 .LP
 177 This function may be called from user or kernel context.
 178 .SH SEE ALSO
 179 .sp
 180 .LP
 181 \fBcsx_event_handler\fR(9E)
 182 .sp
 183 .LP
 184 \fIPC Card 95 Standard,\fR PCMCIA/JEIDA