ISpVoice::WaitUntilDone

Microsoft Speech SDK

The Microsoft.com Speech website Microsoft Speech SDK SAPI 5.1

ISpVoice::WaitUntilDone

ISpVoice::WaitUntilDone blocks the caller until either the voice has completed speaking or the specified time interval has elapsed.

HRESULT WaitUntilDone(
   ULONG   msTimeout
);

Parameters

msTimeout
[in] Timeout period in milliseconds. INFINITE may be used to prevent this method from timing out.

Return values

Value Description
S_OK Function completed successfully.
S_FALSE Wait time interval was exceeded.

Remarks

This call may be used after a single asynchronous Speak (or SpeakStream) call, or after several calls have been queued. In either case it will return only after all pending calls have been completed (or after the specified time interval has elapsed).