Export (0) Print
Expand All

HttpListenerPrefixCollection.Clear Method

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

Namespace:  System.Net
Assembly:  System (in System.dll)

'Declaration
Public Sub Clear

Implements

ICollection(Of T).Clear

ExceptionCondition
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.

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.

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft