Share via


ISpVoice::Skip

Other versions of this page are also available for the following:

Windows Mobile Not SupportedWindows Embedded CE Supported

8/28/2008

This method causes the voice to skip forward or backward the specified number of items within the text of the current speak call.

Syntax

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

Parameters

  • pItemType
    [in] Pointer to the type of item to skip. Currently "SENTENCE" is the only type supported.
  • lNumItems
    [in] Number of items to skip in the current speak request. If lNumItems is a positive number, the voice will skip forward. If it is a negative number, 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 the actual number of items skipped.

Return Value

The following table shows the possible return values.

Value Description

S_OK

Function completed successfully.

E_INVALIDARG

pItemType is invalid or bad.

E_POINTER

pulNumSkipped is invalid or bad.

SPERR_VOICE_PAUSED

Voice is in a paused state and cannot be skipped.

Requirements

Header sapi.h, sapi.idl
Library sapilib.lib
Windows Embedded CE Windows CE .NET 4.1 and later

See Also

Reference

ISpVoice
SAPI Interfaces