Inside Macintosh: Apple Game Sprockets Guide /

Chapter 3 - InputSprocket / InputSprocket Reference

InputSprocket Functions / Managing Element Lists

ISpElementList_Extract

You can use the ISpElementList_Extract function to extract and count elements in an element list.

OSStatus ISpElementList_Extract (
	ISpElementListReference inElementList,
	UInt32 inBufferCount,
	UInt32 *outCount,
	ISpElementReference *buffer);

inElementList

A reference to the element list to extract elements from.

inBufferCount

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

outCount

The number of element references on the element list.

buffer

A pointer to an array of element references.

function result

A result code.

DESCRIPTION

The ISpElementList_Extract function takes, in the buffer parameter, a pointer to an array of element references and, in the inBufferCount parameter, the number of element references in the array. The ISpElementList_Extract function copies element references from the list specified in the inElementList parameter into that array. If there are more elements in the list than there is space in your array, it copies only as many element references as fit. The function returns the total number of elements in the element list in the outCount parameter.