SpeechSynthesizer::SpeakAsyncCancel Method (Prompt^)

.NET Framework (current version)
 

Cancels the asynchronous synthesis operation for a queued prompt.

Namespace:   System.Speech.Synthesis
Assembly:  System.Speech (in System.Speech.dll)

C#
C++
F#
VB
Copy 
public:
void SpeakAsyncCancel(
	Prompt^ prompt
)

Parameters

prompt
Type: System.Speech.Synthesis::Prompt^

The content for which to cancel a speak operation.

You can also use this method to cancel an asynchronous speak operation for the following:

When you call SpeechSynthesizer::SpeakAsync, SpeechSynthesizer::SpeakAsync, or SpeakSsmlAsync, System.Speech creates a Prompt object and populates it with the contents of the method's parameter, and returns the Prompt object. If you retain a copy of the returned Prompt, you can pass it into SpeakAsyncCancel to cancel speaking content specified in a String or a PromptBuilder object.

.NET Framework
Available since 3.0
Return to top
Show: