ISpVoice::Skip

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

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 Values

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

OS Versions: Windows CE .NET 4.1 and later.
Header: Sapi.h, Sapi.idl.
Link Library: Sapilib.lib.

See Also

ISpVoice | SAPI Interfaces

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.