This documentation is archived and is not being maintained.

Clipboard.GetAudioStream Method

Retrieves an audio stream from the Clipboard.

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

static member GetAudioStream : unit -> Stream 

Return Value

Type: System.IO.Stream
A Stream containing audio data or a null reference (Nothing in Visual Basic) if the Clipboard does not contain any data in the WaveAudio format.

ExceptionCondition
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.

Use the ContainsAudio method to determine whether the Clipboard contains audio data before retrieving it with this method.

Use the SetAudio method to add audio data to the Clipboard.

NoteNote

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.

The following example demonstrates this member.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: