Clipboard.SetAudio Method (Stream)

 

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)

Public Shared Sub SetAudio (
	audioStream As Stream
)

Parameters

audioStream
Type: System.IO.Stream

A Stream containing the audio data.

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.

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.

System_CAPS_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 Function SwapClipboardAudio( _
    ByVal replacementAudioStream As System.IO.Stream) _
    As System.IO.Stream

    Dim returnAudioStream As System.IO.Stream = Nothing

    If (Clipboard.ContainsAudio()) Then
        returnAudioStream = Clipboard.GetAudioStream()
        Clipboard.SetAudio(replacementAudioStream)
    End If

    Return returnAudioStream

End Function

UIPermission

for adding audio data to the system Clipboard. Associated enumeration: UIPermissionClipboard.AllClipboard

.NET Framework
Available since 2.0
Return to top
Show: