Inside Macintosh: Apple Game Sprockets Guide /

Chapter 3 - InputSprocket / InputSprocket Reference

InputSprocket Functions / Obtaining Data From Elements

ISpElement_GetComplexState

Use the ISpElement_GetComplexState function to obtain the current state of an element.

OSStatus ISpElement_GetComplexState (
	const ISpElementReference inElement,
	UInt32 buflen,
	void *state);

inElement

A reference to the element whose state you want to get.

buflen

The length of the buffer allocated to hold the data. This must match the dataSize field of the element's element definition structure.

state

On entry, a pointer to a buffer to hold the data. On exit, the state of the specified element.

function result

A result code.

DESCRIPTION

The ISpElement_GetComplexState function gets the current state of the element specified in the inElement parameter and stores it in the location indicated by the state parameter. You pass in the length of the buffer to hold the data in the buflen parameter. The ISpElement_GetComplexState function copies as much data as will fit into the buffer.