ISpVoice::WaitUntilDone

This method 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" can be used to prevent this method from timing out.

Return Values

The following table shows the possible return values.

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

Remarks

This call can 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).

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.