Clipboard.ContainsAudio Method

Definition

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

public:
 static bool ContainsAudio();
public static bool ContainsAudio ();
static member ContainsAudio : unit -> bool
Public Shared Function ContainsAudio () As Boolean

Returns

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

Exceptions

The Clipboard could not be cleared. This typically occurs when the Clipboard is being used by another process.

The current thread is not in single-threaded apartment (STA) mode. Add the STAThreadAttribute to your application's Main method.

Examples

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;
}
' 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

Remarks

Use this 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.

Security

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

Applies to

See also