Important: The information in this document is obsolete and should not be used for new development.
SRRemoveIndexedItem
You can use theSRRemoveIndexedItemfunction 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
TheSRRemoveIndexedItemfunction removes from the speech object specified by thecontainerparameter the subitem located at the position specified by theindexparameter. IfSRRemoveIndexedItemcompletes 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
indexparameter must be greater than or equal to 0 and less than the number of subitems in the specified container object. (You can call theSRCountItemsfunction to determine the number of subitems contained in a speech object.) If the index you specify is not in this range,SRRemoveIndexedItemreturns the result codekSRParamOutOfRange.