IWMPError::clearErrorQueue method

[The feature associated with this page, Windows Media Player SDK, is a legacy feature. It has been superseded by MediaPlayer. MediaPlayer has been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer instead of Windows Media Player SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The clearErrorQueue method clears the errors from the error queue.

Syntax

public void clearErrorQueue();

Public Sub clearErrorQueue()
Implements IWMPError.clearErrorQueue

Parameters

This method has no parameters.

Return value

This method does not return a value.

Remarks

Use this method to clear the error queue after a series of errors has been processed.

You should set IWMPSettings.enableErrorDialogs to false if you choose to display custom error messages.

Examples

The following example uses clearErrorQueue in an Error event handler to empty the error queue after all error descriptions have been displayed. The AxWMPLib.AxWindowsMediaPlayer object is represented by the variable named player.

private void player_ErrorEvent_clearErrorQueue(object sender, System.EventArgs e)
{
    // Store the number of errors in the queue.
    int max = player.Error.errorCount;

    // Loop through the list of errors.
    for (int i = 0; i < max; i++)
    {
        // Get the description for this error.
        string errDesc = player.Error.get_Item(i).errorDescription;

        // Display the error message.
        System.Windows.Forms.MessageBox.Show(errDesc);
    }

    // Clear the error queue to prepare for the next group of errors.
    player.Error.clearErrorQueue();
}

Public Sub player_ErrorEvent_clearErrorQueue(ByVal sender As Object, ByVal e As System.EventArgs) Handles player.ErrorEvent

    ' Store the number of errors in the queue.
    Dim max As Integer = player.Error.errorCount

    ' Loop through the list of errors.
    For i As Integer = 0 To (max - 1)

        ' Get the description for this error.
        Dim errDesc As String = player.Error.Item(i).errorDescription

        ' Display the error message.
        System.Windows.Forms.MessageBox.Show(errDesc)

    Next i

    ' Clear the error queue to prepare for the next group of errors.
    player.Error.clearErrorQueue()

End Sub

Requirements

Requirement	Value
Version	Windows Media Player 9 Series or later
Namespace	WMPLib
Assembly	Interop.WMPLib.dll (Interop.WMPLib.dll.dll)

See also

IWMPError Interface (VB and C#)

IWMPSettings.enableErrorDialogs (VB and C#)