Export (0) Print
Expand All

HttpModuleCollection Class

Provides a way to index and retrieve a collection of IHttpModule objects.

Namespace: System.Web
Assembly: System.Web (in system.web.dll)

public sealed class HttpModuleCollection : NameObjectCollectionBase
public final class HttpModuleCollection extends NameObjectCollectionBase
public final class HttpModuleCollection extends NameObjectCollectionBase
Not applicable.

The following code example demonstrates the AllKeys property and the GetKey and CopyTo methods of the HttpModuleCollection class. The example gets the application object for the current request from the current HttpContext object. It then extracts the HttpModuleCollection object from the application instance and displays the names of the IHttpModule objects.

<%@ Page language="C#" %>
<%@ Import Namespace = "System.Data"  %>
<script runat="server">
// System.Web.HttpModuleCollection.AllKeys;GetKey;CopyTo

void Page_Load(object sender, System.EventArgs e)
{
    // Get the HttpContext object for the current request.
    HttpContext myHttpContext = HttpContext.Current;
    // Get the application object for the current request.
    HttpApplication myHttpApplication = myHttpContext.ApplicationInstance;
    // Get the collection of all HTTPModule objects for the current application.
    HttpModuleCollection myHttpModuleCollection = myHttpApplication.Modules;

    // Get the name of the HttpModule object at index 1.
    string httpModuleName = myHttpModuleCollection.GetKey(1);
    Response.Write("The name of the HttpModule object at index 1" + " is " +"'"+  httpModuleName+"'." + "<br><br>"); 

    string[] allModules = myHttpModuleCollection.AllKeys;

    // Display the names of all HttpModule objects.
    Response.Write("<b>The HttpModule objects contained in the HttpModuleCollection are:</b><br>");

    for(int i=0; i < allModules.Length; i++)
       Response.Write("Module" + i + "  : " + allModules[i] + "<br>");

    // Copy the HttpModule objects in the collection into an array.
    System.Array httpModuleArray = Array.CreateInstance(typeof(object),myHttpModuleCollection.AllKeys.Length);
    myHttpModuleCollection.CopyTo(httpModuleArray,0);
    Response.Write("<br><br><b>Successfully copied the HttpModule objects in the HttpModuleCollection to an array."+
       "<br>Displaying the HttpModule objects in array:</b><br>");

    for(int i=0; i < httpModuleArray.Length; i++)
       Response.Write("Module" + i + ": " + httpModuleArray.GetValue(i) + "<br>");

}
</script>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head id="Head1" runat="server">
    <title>HttpModuleCollection Example</title>
</head>
<body>
</body>
</html>


<%@ Page language="VJ#" %>
<%@ Import Namespace = "System.Data"  %>
<script runat="server">
// System.Web.HttpModuleCollection.AllKeys;GetKey;CopyTo

void Page_Load(Object sender, System.EventArgs e)
{
    // The following example demonstrates the AllKeys property and the GetKey and
    // CopyTo methods of the HttpModuleCollection class. The example gets the 
    // application object for the current request from the current HttpContext 
    // object. It then extracts the HttpModuleCollection object from the 
    // application instance and displays the names of the HttpModule objects.


    // Get the HttpContext object for the current request.
    HttpContext myHttpContext = HttpContext.get_Current();
    // Get the application object for the current request.
    HttpApplication myHttpApplication = myHttpContext.get_ApplicationInstance();
    // Get the collection of all HTTPModule objects for the current application.
    HttpModuleCollection myHttpModuleCollection = 
        myHttpApplication.get_Modules();
           
    // Get the name of the HttpModule object at index 1.
    String httpModuleName = myHttpModuleCollection.GetKey(1);
    get_Response().Write("The name of the HttpModule object at index 1" 
        + " is " +"'"+  httpModuleName+"'." + "<br><br>"); 
          
    String allModules[] = myHttpModuleCollection.get_AllKeys();
          
    // Display the names of all HttpModule objects.
    get_Response().Write("<b>The HttpModule objects contained in the " 
        + "HttpModuleCollection are:</b><br>");
    for(int i=0; i < allModules.get_Length(); i++) {
        get_Response().Write("Module" + i + "  : " 
            + allModules[i] + "<br>");
    }

    // Copy the HttpModule objects in the collection into an array.
    System.Array httpModuleArray = Array.CreateInstance(Object.class.ToType(),
        myHttpModuleCollection.get_AllKeys().get_Length());
    myHttpModuleCollection.CopyTo(httpModuleArray,0);
    
    get_Response().Write("<br><br><b>Successfully copied the HttpModule " 
        + "objects in the HttpModuleCollection to an array."
        + "<br>Displaying the HttpModule objects in array:</b><br>");
    
    for(int i=0; i < httpModuleArray.get_Length(); i++) {
        get_Response().Write("Module" + i + ": " + httpModuleArray.GetValue(i) 
            + "<br>");
    }
} // Page_Load
</script>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head id="Head1" runat="server">
    <title>HttpModuleCollection Example</title>
</head>
<body>
</body>
</html>

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft