ISpVoice::GetStatus
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method gets the current rendering and event status associated with this voice.
Syntax
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 Value
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
| Header | sapi.h, sapi.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |