ISpVoice::GetStatus

  • Article

This method gets the current rendering and event status associated with this voice.

HRESULT GetStatus(
  SPVOICESTATUS* pStatus,
  WCHAR** ppszLastBookmark
);

Parameters

  • pStatus
    [out] Pointer to an SPVOICESTATUS structure containing status information. This pointer can be NULL if the caller does not want the information.
  • ppszLastBookmark
    [out] Address of a pointer to a null-terminated string (allocated by CoTaskMemAlloc) specifying the text of the last bookmark reached, or NULL if the caller does not want the string. If there is no last bookmark, this parameter contains NULL. Applications calling this method must call CoTaskMemFree to free the retrieved string.

Return Values

The following table shows the possible return values.

Value Description
S_OK Function completed successfully.
E_POINTER Invalid pointer.
E_OUTOFMEMORY Exceeded available memory.

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.