ISpVoice::Skip (SAPI 5.3)

Speech API 5.3
Microsoft Speech API 5.3

ISpVoice::Skip

ISpVoice::Skip causes the voice to skip forward or backward the specified number of items within the text of the current speak call.

HRESULT Skip(
   LPCWSTR   *pItemType,
   long       lNumItems,
   ULONG     *pulNumSkipped
);

Parameters

pItemType
[in,string] Specifies the type of item to skip. Currently "SENTENCE" is the only type supported.
lNumItems
[in] Specifies the number of items to skip in the current speak request. If lNumItems is a positive number, the voice will skip forward, and if it is negative, the voice will skip backward.  If lNumItems is 0, the voice will skip back to the beginning of the current item.
pulNumSkipped
[out] Pointer to a ULONG which will be set to the actual number of items skipped.

Return values

ValueDescription
S_OKFunction completed successfully.
E_INVALIDARGpItemType is invalid or bad.
E_POINTERpulNumSkipped is invalid or bad.
SPERR_VOICE_PAUSEDVoice is in a paused state and may not be skipped.
Show: