IEnumSpObjectTokens::Next

Microsoft Speech SDK SAPI 5.1

IEnumSpObjectTokens::Next retrieves the next object token in the enumeration sequence.

If there are fewer than the requested number of elements left in the sequence, the remaining elements are retrieved.

HRESULT Next(
   ULONG              celt,
   ISpObjectToken   **pelt,
   ULONG             *pceltFetched
);

celt: [in] The number of object tokens to retrieve.
pelt: [out] Address of an array that receives ISpObjectToken pointers. If an error value is returned, no entries in the array are valid.
pceltFetched: [out] Address of a variable that receives the number of ISpObjectToken pointers actually copied to the array. This parameter cannot be NULL if celt is greater than one. If this parameter is NULL, celt must be one.

Value

Description

S_OK

Function completed successfully.

E_POINTER

One of the following errors was encountered:

pelt is bad or invalid,

pceltFetched is bad or invalid,

pceltFetched is bad and celt is greater than one.

E_INVALIDARG

celt is zero.

SPERR_UNINITIALIZED

Attribute parser interface is not initialized.

S_FALSE

celt is greater than the number of objects available.

FAILED (hr)

Appropriate error message.