forked from cellularmitosis/ADC-reference-library-2009-july
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlisting12.html
More file actions
executable file
·448 lines (393 loc) · 19.7 KB
/
Copy pathlisting12.html
File metadata and controls
executable file
·448 lines (393 loc) · 19.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<!-- BEGIN META TAG INFO -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="home" href="http://developer.apple.com/">
<link rel="find" href="http://developer.apple.com/search/">
<link rel="stylesheet" type="text/css" href="../../documentation/css/adcstyle.css" title="fonts">
<script language="JavaScript" src="../../documentation/js/adc.js" type="text/javascript"></script>
<!-- END META TAG INFO -->
<!-- BEGIN TITLE -->
<title>MoreSCF - /MoreSCF/MoreSCFPortScanner.h</title>
<!-- END TITLE -->
<script language="JavaScript">
function JumpToNewPage() {
window.location=document.scpopupmenu.gotop.value;
return true;
}
</script>
</head>
<!-- BEGIN BODY OPEN -->
<body>
<!--END BODY OPEN -->
<!-- START CENTER OPEN -->
<center>
<!-- END CENTER OPEN -->
<!-- BEGIN LOGO AND SEARCH -->
<!--#include virtual="/includes/adcnavbar"-->
<!-- END LOGO AND SEARCH -->
<!-- START BREADCRUMB -->
<div id="breadcrumb">
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td scope="row"><img width="340" height="10" src="images/1dot.gif" alt=""></td>
<td><img width="340" height="10" src="images/1dot.gif" alt=""></td>
</tr>
<tr valign="middle">
<td align="left" colspan="2">
<a href="http://developer.apple.com/">ADC Home</a> > <a href="../../referencelibrary/index.html">Reference Library</a> > <a href="../../samplecode/index.html">Sample Code</a> > <a href="../../samplecode/Networking/index.html">Networking</a> > <a href="../../samplecode/Networking/idxDarwin-date.html">Darwin</a> > <A HREF="javascript:location.replace('index.html');">MoreSCF</A> >
</td>
</tr>
<tr>
<td colspan="2" scope="row"><img width="680" height="35" src="images/1dot.gif" alt=""></td>
</tr>
</table>
</div>
<!-- END BREADCRUMB -->
<!-- START MAIN CONTENT -->
<!-- START TITLE GRAPHIC AND INTRO-->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td><h1><div id="pagehead">MoreSCF</div></h1></td>
</tr>
</table>
<!-- END TITLE GRAPHIC AND INTRO -->
<!-- START WIDE COLUMN -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td id="scdetails">
<h2>/MoreSCF/MoreSCFPortScanner.h</h2>
<form name="scpopupmenu" onSubmit="return false;" method=post>
<p><strong>View Source Code:</strong>
<select name="gotop" onChange="JumpToNewPage();" style="width:340px"><option selected value="ingnore">Select File</option>
<option value="listing1.html">/MoreCFQ/MoreCFQ.c</option>
<option value="listing2.html">/MoreCFQ/MoreCFQ.h</option>
<option value="listing3.html">/MoreSCF/MoreSCF.c</option>
<option value="listing4.html">/MoreSCF/MoreSCF.h</option>
<option value="listing5.html">/MoreSCF/MoreSCFCCLScanner.c</option>
<option value="listing6.html">/MoreSCF/MoreSCFCCLScanner.h</option>
<option value="listing7.html">/MoreSCF/MoreSCFDigest.c</option>
<option value="listing8.html">/MoreSCF/MoreSCFDigest.h</option>
<option value="listing9.html">/MoreSCF/MoreSCFHelpers.c</option>
<option value="listing10.html">/MoreSCF/MoreSCFHelpers.h</option>
<option value="listing11.html">/MoreSCF/MoreSCFPortScanner.c</option>
<option value="listing12.html">/MoreSCF/MoreSCFPortScanner.h</option>
<option value="listing13.html">/MoreSCF/MoreSCFTest/MoreSCFTest.c</option>
<option value="listing14.html">/MoreSCF/Read Me About MoreSCF.txt</option>
<option value="listing15.html">/Read Me.txt</option></select>
</p>
</form>
<p><strong><a href="MoreSCF.zip">Download Sample</a></strong> (“MoreSCF.zip”, 126.7K)<BR>
<strong><a href="MoreSCF.dmg">Download Sample</a></strong> (“MoreSCF.dmg”, 191.8K)</p>
<!--
<p><strong><a href="#">Download Sample</a></strong> (“filename.sit”, 500K)</p>
-->
</td>
</tr>
<tr>
<td scope="row"><img width="680" height="10" src="images/1dot.gif" alt=""><br>
<img height="1" width="680" src="images/1dot_919699.gif" alt=""><br>
<img width="680" height="20" src="images/1dot.gif" alt=""></td>
</tr>
<tr>
<td scope="row">
<!--googleon: index -->
<pre class="sourcecodebox">/*
File: MoreSCFPortScanner.h
Contains: Code to generate list of network ports on Mac OS X.
Written by: DTS, based on code by Network preferences engineering
Copyright: Copyright (c) 2007 by Apple Inc., All Rights Reserved.
Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc.
("Apple") in consideration of your agreement to the following terms, and your
use, installation, modification or redistribution of this Apple software
constitutes acceptance of these terms. If you do not agree with these terms,
please do not use, install, modify or redistribute this Apple software.
In consideration of your agreement to abide by the following terms, and subject
to these terms, Apple grants you a personal, non-exclusive license, under Apple's
copyrights in this original Apple software (the "Apple Software"), to use,
reproduce, modify and redistribute the Apple Software, with or without
modifications, in source and/or binary forms; provided that if you redistribute
the Apple Software in its entirety and without modifications, you must retain
this notice and the following text and disclaimers in all such redistributions of
the Apple Software. Neither the name, trademarks, service marks or logos of
Apple Inc. may be used to endorse or promote products derived from the
Apple Software without specific prior written permission from Apple. Except as
expressly stated in this notice, no other rights or licenses, express or implied,
are granted by Apple herein, including but not limited to any patent rights that
may be infringed by your derivative works or by other works in which the Apple
Software may be incorporated.
The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
COMBINATION WITH YOUR PRODUCTS.
IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION
OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT
(INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Change History (most recent first):
$Log: MoreSCFPortScanner.h,v $
Revision 1.12 2006/11/24 12:40:49
Document the old vs new implementation. Add user-visible name keys for FireWire and Bluetooth on the old implementation.
Revision 1.11 2006/03/27 14:42:42
Eliminate high-bit set characters.
Revision 1.10 2006/03/24 16:15:35
Tidy headers: eliminate #pragma once, check C++ guards, eliminate bogus pragmas.
Revision 1.9 2006/03/24 15:44:46
Updated copyright.
Revision 1.8 2006/03/24 12:38:54
Eliminate "pascal" keyword.
Revision 1.7 2006/03/24 11:30:20
Eliminated "MoreSetup.h" to make it easier for folks to copy MIB source into their projects.
Revision 1.6 2003/10/25 02:15:00
Get file name right in header comment.
Revision 1.5 2003/02/26 20:59:18
<rdar://problem/3183087> Added support for V.92 modem hold.
Revision 1.4 2002/11/09 00:01:09
Added compile time environment check. When using framework includes, explicitly include the frameworks we need. Convert nil to NULL.
Revision 1.3 2002/01/31 10:20:37
Added bug numbers for the bugs requesting port scanner APIs.
Revision 1.2 2002/01/22 06:17:22
Total rewrite. Kept Robert's ideas but complete rewrote the implementation and also changed the API to work better in an SCF environment.
Revision 1.1 2002/01/16 22:52:39
First checked in.
*/
#ifndef _MORESCFPORTSCANNER_H
#define _MORESCFPORTSCANNER_H
/////////////////////////////////////////////////////////////////
// System Interfaces
#include <IOKit/IOKitLib.h>
#include <CoreServices/CoreServices.h>
/////////////////////////////////////////////////////////////////
#ifdef __cplusplus
extern "C" {
#endif
/////////////////////////////////////////////////////////////////
// Port Scanner
// IMPORTANT
// In Mac OS X 10.4 Apple introduced a new API, SCNetworkInterfaceCopyAll, which returns
// a list of networking ports and their user-visible names. If that API is available,
// you should use it. MoreSCCreatePortArray will use this API automatically if it's
// present.
//
// If MoreSCCreatePortArray uses the new API, your port name callback (as installed by
// MoreSCFSetPortNameCallback) will not be called (because the system takes care of
// the getting the port's user visible name). Thus, if you require 10.4 or later,
// you don't need to install this callback.
extern OSStatus MoreSCCreatePortArray(CFArrayRef *portArray);
// Builds a list of network ports and returns their attributes as a CFArray
// of CFDictionaries, with one dictionary per port. The array is sorted in
// the default order which one would display the ports to the user (and set
// them up in the IPv4 service order array). Each entries contains the
// following required keys.
//
// o kSCPropUserDefinedName -- the user-visible name of the port
//
// o kSCPropNetInterfaceHardware -- the hardware type of the interface,
// typically kSCEntNetEthernet, kSCEntNetAirPort, kSCEntNetFireWire,
// or kSCEntNetModem
//
// o kSCPropNetInterfaceType -- either kSCValNetInterfaceTypeEthernet
// or kSCValNetInterfaceTypePPP
//
// o kSCPropNetInterfaceDeviceName -- typically the BSD name of the
// network device; for serial-like devices this is the base
// name, including the suffix, but not including any leading "cu."
// and so on
//
// The dictionary may also contain values for the following keys.
//
// o kSCPropNetInterfaceSubType -- either kSCValNetInterfaceSubTypePPPSerial
// or kSCValNetInterfaceSubTypePPPoE, only present if
// kSCPropNetInterfaceType is kSCValNetInterfaceTypePPP
//
// o kSCPropMACAddress -- the MAC address for Ethernet-like devices,
// encoded as a colon delimited string
//
// o kMoreSCPropNetInterfaceHardwareVariant -- set to
// kMoreSCValNetInterfaceHardwareVariantIrDACOMM or kMoreSCValNetInterfaceHardwareVariantBluetooth
// to distinguish modem/serial ports from IrDA COMM or Bluetooth serial ports
//
// o kSCPropNetInterfaceSupportsModemOnHold -- may be present for
// modem devices (kSCPropNetInterfaceHardware is kSCEntNetModem); if
// present, this is a CFNumber of value 0 or 1 indicating whether the
// modem supports V.92 call waiting; if not present, assume 0
//
// The dictionary may also contain other keys. These keys were set up
// during the operation of the function. You may find their values useful.
//
// o "AAPL,slot-name" -- For PCI devices this is the name of the
// slot that the device is plugged in to.
//
// o "IOChildIndex" -- For PCI devices thish is the port number.
// To tell you the truth I'm not exactly sure what this means )-:
//
// o kIOBSDNameKey -- For generic Ethernet-like devices this is the
// BSD name of the underlying device.
//
// o kIOTTYBaseNameKey -- For generic serial ports this is the
// base name of the serial driver.
//
// When running on pre-10.4 systems, this function takes a guess at the
// user-visible name of the port and then calls your callback function (which you
// install using MoreSCFSetPortNameCallback) to refine that name. If your
// callback function doesn't override the user-visible name
// this function will just returns its guess. Note that the code
// that generates the guess is bug-for-bug compatible with the
// Network preferences panel in Mac OS X 10.1.x and may not produce
// ideal results. Moreover, the guess is not localised. Fortunately, this
// code isn't used on modern systems.
//
// portArray must not be NULL.
// *portArray must be NULL.
// On success, *portArray will be non-NULL; the caller is responsible for
// releasing it.
// On error, *portArray will be NULL.
#define kMoreSCPropNetInterfaceHardwareVariant CFSTR("HardwareVariant")
#define kMoreSCValNetInterfaceHardwareVariantIrDACOMM CFSTR("IrDA-IrCOMM")
#define kMoreSCValNetInterfaceHardwareVariantBluetooth CFSTR("Bluetooth")
/////////////////////////////////////////////////////////////////
// Localisable Port Names
// You can install a MoreSCFPortNameCallback to return the localised
// name for a port. The function is called with a non-localised
// port label and is expected to return a localised name.
//
// If you don't install a callback the default (English) names for
// the ports are used.
typedef kern_return_t (*MoreSCFPortNameCallback)(io_object_t interface,
CFMutableDictionaryRef interfaceInfo,
CFStringRef proposedUserVisibleName,
CFStringRef *userVisibleName);
// MoreSCF calls this callback when it needs to determine the user-visible
// name of a port. The callback is provided with a reference to the
// I/O Registry object, a dictionary of information about that object
// (this is basically the same dictionary as is returned by
// MoreSCCreatePortArray, without the kSCPropUserDefinedName of course)
// and a proposed user-visible name. The routine can either leave
// *userVisibleName as NULL, in which case MoreSCF uses the
// proposedUserVisible name, or set it to a user-visible name that's
// better than the proposed one.
//
// For example, your code might have a set of localised strings
// for each of the port labels listed below, and return the
// appropriate string based on the current user's preferences. Or
// your code might have special information about a specific
// interface, and return a custom string for that interface.
//
// MoreSCF does keyword substitution (for example, replacing
// %2$@ with the PCI slot name that the device resides in) *after*
// calling this routine, so you don't have to parse these variable
// keywords out of proposedUserVisibleName when deciding on your
// localisations. You can also modify the substitions that are
// performed by returning a string with different keywords.
//
// interface will not be 0.
// interfaceInfo will not be NULL.
// proposedUserVisibleName will not be NULL. It will be either one of the
// labels listed below, or a more specific name derived from the I/O Registry.
// userVisibleName will not be NULL.
// *userVisibleName will be NULL.
// On success, *userVisibleName may be NULL or not NULL. If not NULL,
// it's the user visible name of the port. If NULL, your code doesn't
// have a user visible name for this type of port.
// On error, *userVisibleName must be NULL.
//
// *userVisibleName can contain the following strings which are substituted
// by MoreSCF upon return.
//
// %1$@ is the BSD name of the device
// %2$@ is the PCI slot name of the device
// %3$@ is the function number of a multifunction PCI device
// %4$@ is the lowercased TTY base name of the device
// Why lowercase? Because that's what the 10.1.x control
// panel does, for reasons unknown.
//
// IMPORTANT
// If you require Mac OS X 10.4 or later, you don't need to install
// this callback. See the comments at the top of this file for an
// explanation.
#define kMoreSCPortLabelEthernetBuiltIn CFSTR("Built-in Ethernet")
// built-in Ethernet
#define kMoreSCPortLabelFireWireBuiltIn CFSTR("Built-in FireWire")
// built-in FireWire
#define kMoreSCPortLabelAirPort CFSTR("AirPort")
// Apple AirPort
#define kMoreSCPortLabelWireless CFSTR("Wireless Network Adaptor")
// non-AirPort wireless
#define kMoreSCPortLabelEthernetPCI CFSTR("PCI Ethernet Slot %2$@")
// generic PCI card
#define kMoreSCPortLabelEthernetPCIMultiport CFSTR("PCI Ethernet Slot %2$@, Port %3$@")
// multiport PCI card (I think we handle this wrongly but it's compatible
// with the Network preferences panel)
#define kMoreSCPortLabelEthernet CFSTR("Ethernet Adaptor (%1$@)")
// non-PCI Ethernet
#define kMoreSCPortLabelModemInternal CFSTR("Internal Modem")
// built-in modem
#define kMoreSCPortLabelModemPort CFSTR("Modem Port")
// built-in serial port (eg Beige G3)
#define kMoreSCPortLabelPrinterPort CFSTR("Printer Port")
// ditto
#define kMoreSCPortLabelModemPrinterPort CFSTR("Modem/Printer Port")
// built-in serial port (eg Wallstreet)
#define kMoreSCPortLabelModemUSB CFSTR("USB Modem")
// generic USB modem, usually we find a better name in I/O registry
#define kMoreSCPortLabelModemIrDA CFSTR("IrDA Modem Port")
// USB-based IrDA, including built-in port on TiBook
#define kMoreSCPortLabelModemBluetooth CFSTR("Bluetooth")
// Bluetooth modem
#define kMoreSCPortLabelSerial CFSTR("%4$@-port")
// generic serial port
extern void MoreSCFSetPortNameCallback(MoreSCFPortNameCallback callback);
// Installs the callback function, eliminating any existing one.
// Pass NULL to remove your callback.
//
// IMPORTANT
// If you require Mac OS X 10.4 or later, you don't need to install
// this callback. See the comments at the top of this file for an
// explanation.
/////////////////////////////////////////////////////////////////
#ifdef __cplusplus
}
#endif
#endif
</pre>
<!--googleoff: index -->
</td>
</tr>
</table>
<!-- END WIDE COLUMN -->
<!-- END MAIN CONTENT -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td><div style="width: 100%; height: 1px; background-color: #919699; margin-top: 5px; margin-bottom: 15px"></div></td>
</tr>
<tr>
<td align="center"><br/>
<table border="0" cellpadding="0" cellspacing="0" class="graybox">
<tr>
<th>Did this document help you?</th>
</tr>
<tr>
<td>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=1&url=/samplecode/MoreSCF/listing12.html%3Fid%3DDTS10000702-2.0&media=dvd" target=_new>Yes</a>: Tell us what works for you.</div>
<div style="margin-bottom: 8px"><a href="http://developer.apple.com/feedback/?v=2&url=/samplecode/MoreSCF/listing12.html%3Fid%3DDTS10000702-2.0&media=dvd" target=_new>It’s good, but:</a> Report typos, inaccuracies, and so forth.</div>
<div><a href="http://developer.apple.com/feedback/?v=3&url=/samplecode/MoreSCF/listing12.html%3Fid%3DDTS10000702-2.0&media=dvd" target=_new>It wasn’t helpful</a>: Tell us what would have helped.</div>
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- START BOTTOM APPLE NAVIGATION -->
<!--#include virtual="/includes/footer"-->
<!-- END BOTTOM APPLE NAVIGATION -->
<!-- START CENTER CLOSE -->
</center>
<!-- END CENTER CLOSE -->
</body>
</html>