Inside Macintosh: Apple Game Sprockets Guide /

Chapter 3 - InputSprocket / InputSprocket Reference

InputSprocket Functions / Configuring the Application

ISpElement_GetConfigurationInfo

You can use the ISpElement_GetConfigurationInfo function to get element kind-specific information for an element--for example, whether a directional pad has eight directions or four or whether to use a certain button first when matching game input requirements with controls. InputSprocket stores this type of information in configuration information structures--for example, the ISpButtonConfigurationInfo, ISpDPadConfigurationInfo, and ISpAxisConfigurationInfo structures, which are built-in.

OSStatus ISpElement_GetConfigurationInfo (
	const ISpElementReference inElement,
	UInt32 buflen,
	void *configInfo);

inElement

A reference to the element whose element kind-specific information you want to get.

buflen

The length of the buffer for holding the information. The size of the configuration structures varies by element kind.

configInfo

On exit, a pointer to the buffer containing the data.

function result

A result code.

DESCRIPTION

The ISpElement_GetConfigurationInfo function returns element kind-specific information for the element specified in the inElement parameter and stores it in the memory pointed to by the configInfo parameter. You pass in the length of the buffer to hold the data in the buflen parameter. If the buffer is not long enough to hold the data, the ISpElement_GetConfigurationInfo function copies as many bytes of data as fit and returns an error.