This documentation is archived and is not being maintained.

Clipboard.SetAudio Method (Stream)

Note: This method is new in the .NET Framework version 2.0.

Adds a Stream to the Clipboard in the WaveAudio format.

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in system.windows.forms.dll)

public static void SetAudio (
	Stream audioStream
)
public static void SetAudio (
	Stream audioStream
)
public static function SetAudio (
	audioStream : Stream
)

Parameters

audioStream

A Stream containing the audio data.

Exception typeCondition

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 a null reference (Nothing in Visual Basic).

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.

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.

// Demonstrates SetAudio, ContainsAudio, and GetAudioStream.
public System.IO.Stream SwapClipboardAudio(
    System.IO.Stream replacementAudioStream)
{
    System.IO.Stream returnAudioStream = null;
    if (Clipboard.ContainsAudio())
    {
        returnAudioStream = Clipboard.GetAudioStream();
        Clipboard.SetAudio(replacementAudioStream);
    }
    return returnAudioStream;
}

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0
Show: