Legacy Documentclose button

Important: The information in this document is obsolete and should not be used for new development.

Previous Book Contents Book Index Next

Inside Macintosh: Speech Recognition Manager /
Chapter 1 - Speech Recognition Manager / Speech Recognition Manager Reference
Speech Recognition Manager Routines / Traversing Speech Objects


SRRemoveIndexedItem

You can use the SRRemoveIndexedItem function to remove a subitem from a container object.

pascal OSErr SRRemoveIndexedItem (
SRSpeechObject container, 
long index);
container
A speech object.
index
An integer ranging from 0 to one less than the number of subitems in the specified speech object.
DESCRIPTION
The SRRemoveIndexedItem function removes from the speech object specified by the container parameter the subitem located at the position specified by the index parameter. If SRRemoveIndexedItem completes successfully, the number of subitems in the container object is reduced by 1, and the index of each subitem that follows the removed item is reduced by 1.

The value passed in the index parameter must be greater than or equal to 0 and less than the number of subitems in the specified container object. (You can call the SRCountItems function to determine the number of subitems contained in a speech object.) If the index you specify is not in this range, SRRemoveIndexedItem returns the result code kSRParamOutOfRange.


Previous Book Contents Book Index Next

© Apple Computer, Inc.
22 JAN 1997