Clipboard.SetAudio Method (Stream)

.NET Framework (current version)

Note
The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Clears the Clipboard and then adds a Stream in the WaveAudio format.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)

Syntax

C++

static member SetAudio : 
        audioStream:Stream -> unit

Parameters

audioStream: Type: System.IO.Stream
A Stream containing the audio data.

Exceptions

Exception	Condition
ExternalException	The Clipboard could not be cleared. This typically occurs when the Clipboard is being used by another process.
ThreadStateException	The current thread is not in single-threaded apartment (STA) mode. Add the STAThreadAttribute to your application's Main method.
ArgumentNullException	audioStream is null.

Remarks

To retrieve audio data from the Clipboard, first use the ContainsAudio method to determine whether the Clipboard contains audio data before retrieving it with the GetAudioStream method.

Note
The Clipboard class can only be used in threads set to single thread apartment (STA) mode. To use this class, ensure that your Main method is marked with the STAThreadAttribute attribute.