ISpTTSEngineSite::GetSkipInfo
This method gets the number and type of items to be skipped in the text stream. A skip can be forward, backward, or to the beginning of the current item. The TTS engine should call this method when a call to ISpTTSEngineSite::GetActions returns SPVES_SKIP.
HRESULT GetSkipInfo(
SPVSKIPTYPE* peType,
long* plNumItems
);
Parameters
- peType
[out] Pointer to a value indicating the type of item to skip. Possible values are defined for the SPVSKIPTYPE enumeration. Currently only sentences are supported. - plNumItems
[out] Pointer to the number of items to skip. The number can be positive, signifying a forward skip, or negative to indicate a backward skip. It can also be zero, which specifies a skip to the beginning of the current item.
Return Values
The following table shows the possible return values.
Value | Description |
---|---|
S_OK | Function completed successfully. |
E_POINTER | One of the return addresses is invalid. |
Requirements
OS Versions: Windows CE .NET 4.1 and later.
Header: Sapiddk.h, Sapiddk.idl.
Link Library: Sapilib.lib.
See Also
ISpTTSEngineSite | SAPI Interfaces
Last updated on Saturday, April 10, 2004
© 1992-2003 Microsoft Corporation. All rights reserved.