Export (0) Print
Expand All

HttpListenerPrefixCollection.Clear Method

Note: This method is new in the .NET Framework version 2.0.

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

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

public void Clear ()
public final void Clear ()
public final function Clear ()

Exception typeCondition

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.

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

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2014 Microsoft