Share via

ISpVoice::GetStatus (SAPI 5.4)

  • Article

Microsoft Speech API 5.4

ISpVoice::GetStatus

ISpVoice::GetStatus retrieves the current rendering and event status associated with this voice.

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

Parameters

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

Return values

Value
S_OK
E_POINTER
E_OUTOFMEMORY

Remarks

Because the SPVOICESTATUS structure is closely associated with audio device status, GetStatus will not return an active status for a voice speaking to an audio output stream.