Inside Macintosh: Apple Game Sprockets Guide /

Chapter 3 - InputSprocket / InputSprocket Reference

InputSprocket Functions / Configuring the Application

ISpDevices_ExtractByIdentifier

You can use the ISpDevices_ExtractByIdentifier function to extract and count devices of a certain type that are listed on the systemwide list of devices. This may be useful if you want to find and deactivate input devices--usually the keyboard and mouse--prior to autoconfiguration.

OSStatus ISpDevices_ExtractByIdentifier (
	ISpDeviceIdentifier theIdentifier,
	UInt32 inBufferCount,
	UInt32 *outCount,
	ISpDeviceReference *buffer);

theIdentifier

The type of device to count and extract.

inBufferCount

The number of device references in the array pointed to by the buffer parameter.

outCount

The number of devices of the specified type on the systemwide list.

buffer

A pointer to an array of device references.

function result

A result code.

DESCRIPTION

The ISpDevices_ExtractByIdentifier function takes, in the buffer parameter, a pointer to an array of device references and, in the inBufferCount parameter, the number of device references in the array. The ISpDevices_ExtractByIdentifier function copies into that array, device references of the type specified by the theIdentifier parameter found on the systemwide list of devices. If there are more devices of that type in the list than there is space in the array, it copies only as many device references as fit. The function returns, in the outCount parameter, the total number of devices of the specified type in the systemwide list of devices.