Clear Method
Collapse the table of content
Expand the table of content

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()

Exception Condition
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
Available since 2.0
Return to top
Show:
© 2016 Microsoft