HttpListenerPrefixCollection.Clear Method

Reference

Definition

Namespace:: System.Net

Assembly:: System.Net.HttpListener.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: HttpListenerPrefixCollection.cs

Source:: HttpListenerPrefixCollection.cs

Source:: HttpListenerPrefixCollection.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Removes all the Uniform Resource Identifier (URI) prefixes from the collection.

public:
 virtual void Clear();

public void Clear ();

abstract member Clear : unit -> unit
override this.Clear : unit -> unit

Public Sub Clear ()

Implements

Clear()

Exceptions

HttpListenerException

A Windows function call failed. Check the exception's ErrorCode property to determine the cause of the exception.

ObjectDisposedException

The HttpListener associated with this collection is closed.

Examples

The following code example removes all prefixes in an HttpListenerPrefixCollection.

public static bool RemoveAllPrefixes(HttpListener listener)
{
    // Get the prefixes that the Web server is listening to.
    HttpListenerPrefixCollection prefixes = listener.Prefixes;
    try
    {
        prefixes.Clear();
    }
    // If the operation failed, return false.
    catch
    {
        return false;
    }
    return true;
}

Public Shared Function RemoveAllPrefixes(ByVal listener As HttpListener) As Boolean
    ' Get the prefixes that the Web server is listening to.
    Dim prefixes As HttpListenerPrefixCollection = listener.Prefixes

    Try
        prefixes.Clear()
    Catch ' If the operation failed, return false.
        Return False
    End Try

    Return True
End Function

Remarks

After calling this method, you cannot start the associated HttpListener without adding new prefixes; if you try to do so, an exception is thrown.

Notes to Callers

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in the .NET Framework.

Applies to

Jaa