Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

HttpListenerPrefixCollection.Clear Method

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

Namespace:  System.Net
Assembly:  System (in System.dll)
public void Clear()

Implements

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

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 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.