ContainsAudio Method

Clipboard.ContainsAudio Method ()

 

Indicates whether there is data on the Clipboard in the WaveAudio format.

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

public static bool ContainsAudio()

Return Value

Type: System.Boolean

true if there is audio data on the Clipboard; otherwise, false.

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.

Use this 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 code example demonstrates the use of 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;
}

UIPermission

for access to the system Clipboard. Associated enumeration: UIPermissionClipboard.AllClipboard

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft