mono/linux-packaging-mono
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Imported Upstream version 3.6.0

Browse Source 
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
This commit is contained in:
Jo Shields
2014-08-13 10:39:27 +01:00
commit a575963da9
50588 changed files with 8155799 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

88
mcs/class/System.Web/Documentation/en/System.Web.Hosting/AppDomainFactory.xml Normal file
View File

@@ -0,0 +1,88 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="AppDomainFactory" FullName="System.Web.Hosting.AppDomainFactory">
<TypeSignature Language="C#" Maintainer="auto" Value="public sealed class AppDomainFactory : System.Web.Hosting.IAppDomainFactory" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Web.Hosting.IAppDomainFactory</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a new <see cref="T:System.AppDomain" /> instance for the Web application. This class cannot be inherited. This class was used by earlier versions of the .NET Framework than version 2.0, which uses the <see cref="T:System.Web.Hosting.AppManagerAppDomainFactory" /> class instead.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AppDomainFactory ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Hosting.AppDomainFactory" /> class. This class was used by earlier versions of the .NET Framework than version 2.0, which uses the <see cref="T:System.Web.Hosting.AppManagerAppDomainFactory" /> class instead.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public object Create (string module, string typeName, string appId, string appPath, string strUrlOfAppOrigin, int iZone);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="module" Type="System.String" />
<Parameter Name="typeName" Type="System.String" />
<Parameter Name="appId" Type="System.String" />
<Parameter Name="appPath" Type="System.String" />
<Parameter Name="strUrlOfAppOrigin" Type="System.String" />
<Parameter Name="iZone" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a new application domain for the specified Web application. This class was used by earlier versions of the .NET Framework than version 2.0, which uses the <see cref="T:System.Web.Hosting.AppManagerAppDomainFactory" /> class instead.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A new application domain.</para>
</returns>
<param name="module">
<attribution license="cc4" from="Microsoft" modified="false" />The module containing the Web application.</param>
<param name="typeName">
<attribution license="cc4" from="Microsoft" modified="false" />The type of the Web application.</param>
<param name="appId">
<attribution license="cc4" from="Microsoft" modified="false" />The unique identifier for the Web application.</param>
<param name="appPath">
<attribution license="cc4" from="Microsoft" modified="false" />The path to the Web application's files.</param>
<param name="strUrlOfAppOrigin">
<attribution license="cc4" from="Microsoft" modified="false" />The URL of origin for the Web application.</param>
<param name="iZone">
<attribution license="cc4" from="Microsoft" modified="false" />The zone of origin for the Web application.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

91
mcs/class/System.Web/Documentation/en/System.Web.Hosting/AppManagerAppDomainFactory.xml Normal file
View File

@@ -0,0 +1,91 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="AppManagerAppDomainFactory" FullName="System.Web.Hosting.AppManagerAppDomainFactory">
<TypeSignature Language="C#" Value="public sealed class AppManagerAppDomainFactory : System.Web.Hosting.IAppManagerAppDomainFactory" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Web.Hosting.IAppManagerAppDomainFactory</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates and stops application domains for a Web-application manager. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AppManagerAppDomainFactory ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Hosting.AppManagerAppDomainFactory" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public object Create (string appId, string appPath);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appId" Type="System.String" />
<Parameter Name="appPath" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a new application domain for the specified Web application.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A new application domain for the specified Web application.</para>
</returns>
<param name="appId">
<attribution license="cc4" from="Microsoft" modified="false" />The unique identifier for the new Web application.</param>
<param name="appPath">
<attribution license="cc4" from="Microsoft" modified="false" />The path to the new Web application's files.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Stop">
<MemberSignature Language="C#" Value="public void Stop ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Stops all application domains associated with this application manager. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

62
mcs/class/System.Web/Documentation/en/System.Web.Hosting/ApplicationHost.xml Normal file
View File

@@ -0,0 +1,62 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ApplicationHost" FullName="System.Web.Hosting.ApplicationHost">
<TypeSignature Language="C#" Value="public sealed class ApplicationHost" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>
<see cref="T:System.Web.Hosting.ApplicationHost" /> is introduced in the .NET Framework version 3.5. For more information, see <format type="text/html"><a href="f75a72de-e2f2-4a7a-9574-3f278684ea90">The .NET Framework 3.5 Architecture</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Enables hosting of ASP.NET pages outside the Internet Information Services (IIS) application. This class enables the host to create application domains for processing ASP.NET requests.</para>
</summary>
</Docs>
<Members>
<Member MemberName="CreateApplicationHost">
<MemberSignature Language="C#" Value="public static object CreateApplicationHost (Type hostType, string virtualDir, string physicalDir);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="hostType" Type="System.Type" />
<Parameter Name="virtualDir" Type="System.String" />
<Parameter Name="physicalDir" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates and configures an application domain for hosting ASP.NET.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An instance of a user-supplied class used to marshal calls into the newly created application domain.</para>
</returns>
<param name="hostType">
<attribution license="cc4" from="Microsoft" modified="false" />The name of a user-supplied class to be created in the new application domain.</param>
<param name="virtualDir">
<attribution license="cc4" from="Microsoft" modified="false" />The virtual directory for the application domain; for example, /myapp.</param>
<param name="physicalDir">
<attribution license="cc4" from="Microsoft" modified="false" />The physical directory for the application domain where ASP.NET pages are located; for example, c:\mypages.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

91
mcs/class/System.Web/Documentation/en/System.Web.Hosting/ApplicationInfo.xml Normal file
View File

@@ -0,0 +1,91 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ApplicationInfo" FullName="System.Web.Hosting.ApplicationInfo">
<TypeSignature Language="C#" Value="public sealed class ApplicationInfo" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Hosting.ApplicationInfo" /> object is used by the <see cref="T:System.Web.Hosting.ApplicationManager" /> class for information about running applications. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides information about a running application. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName="ID">
<MemberSignature Language="C#" Value="public string ID { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>For applications running under Microsoft Internet Information Services (IIS), the application ID is the metabase path to the application root, such as /LM/W3SVC/1/Root/application.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the unique identifier for the application.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="PhysicalPath">
<MemberSignature Language="C#" Value="public string PhysicalPath { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Hosting.ApplicationInfo.PhysicalPath" /> property is the path that was passed to the <see cref="M:System.Web.Hosting.ApplicationManager.CreateObject(System.String,System.Type,System.String,System.String,System.Boolean)" /> method when the application was created.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the physical path corresponding to the application's root.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="VirtualPath">
<MemberSignature Language="C#" Value="public string VirtualPath { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Hosting.ApplicationInfo.VirtualPath" /> property is the virtual path that was passed to the <see cref="M:System.Web.Hosting.ApplicationManager.CreateObject(System.String,System.Type,System.String,System.String,System.Boolean)" /> method when the application was created.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the virtual path corresponding to the application's root.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

376
mcs/class/System.Web/Documentation/en/System.Web.Hosting/ApplicationManager.xml Normal file
View File

@@ -0,0 +1,376 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ApplicationManager" FullName="System.Web.Hosting.ApplicationManager">
<TypeSignature Language="C#" Value="public sealed class ApplicationManager : MarshalByRefObject" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.MarshalByRefObject</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Hosting.ApplicationManager" /> object provides lifetime management of objects in the hosting environment for an ASP.NET application. It is responsible for:</para>
<list type="bullet">
<item>
<para>Activating and initializing ASP.NET applications.</para>
</item>
<item>
<para>Managing the application lifetime and the lifetime of objects registered in the application.</para>
</item>
<item>
<para>Exposing objects used by the hosting environment to process ASP.NET application requests.</para>
</item>
<item>
<para>Providing a list of applications running in the hosting process at any given moment.</para>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Manages ASP.NET application domains for an ASP.NET hosting application.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Close">
<MemberSignature Language="C#" Value="public void Close ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If a call to the <see cref="M:System.Web.Hosting.ApplicationManager.Close" /> method reduces the reference count of applications using the application manager to 0, the <see cref="M:System.Web.Hosting.ApplicationManager.Close" /> method calls the <see cref="M:System.Web.Hosting.ApplicationManager.ShutdownAll" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Shuts down all application domains.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreateObject">
<MemberSignature Language="C#" Value="public System.Web.Hosting.IRegisteredObject CreateObject (string appId, Type type, string virtualPath, string physicalPath, bool failIfExists);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Hosting.IRegisteredObject</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appId" Type="System.String" />
<Parameter Name="type" Type="System.Type" />
<Parameter Name="virtualPath" Type="System.String" />
<Parameter Name="physicalPath" Type="System.String" />
<Parameter Name="failIfExists" Type="System.Boolean" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Hosting.ApplicationManager.CreateObject(System.String,System.Type,System.String,System.String,System.Boolean)" /> method is used to create and register objects in the application. Only one object of each type can be created. If you need to create multiple objects of the same type, you must implement an object factory. For more information, see the code example in this topic.</para>
<para>Each application, identified by a unique application identifier, runs in its own application domain. The <see cref="M:System.Web.Hosting.ApplicationManager.CreateObject(System.String,System.Type,System.String,System.String,System.Boolean)" /> method creates an object of the specified type in the application domain of the application specified in the <paramref name="appID" /> parameter. If an application domain does not exist for the specified application, one is created before the object is created.</para>
<para>The <paramref name="failIfExists" /> parameter controls the behavior of the <see cref="M:System.Web.Hosting.ApplicationManager.CreateObject(System.String,System.Type,System.String,System.String,System.Boolean)" /> method when an object of the specified type already exists in the application. When <paramref name="failIfExists" /> is true, the <see cref="M:System.Web.Hosting.ApplicationManager.CreateObject(System.String,System.Type,System.String,System.String,System.Boolean)" /> method throws an <see cref="T:System.InvalidOperationException" /> exception.</para>
<para>When <paramref name="failIfExists" /> is false, the <see cref="M:System.Web.Hosting.ApplicationManager.CreateObject(System.String,System.Type,System.String,System.String,System.Boolean)" /> method returns the existing registered object of the specified type.</para>
<para>The <see cref="M:System.Web.Hosting.ApplicationManager.CreateObject(System.String,System.Type,System.String,System.String,System.Boolean)" /> method calls the overload that takes an additional <paramref name="throwOnError" /> parameter with <paramref name="throwOnError" /> set to false.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates an object for the specified application domain based on type, virtual and physical paths, and a Boolean value indicating failure behavior when an object of the specified type already exists.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A new object of the specified <paramref name="type" />.</para>
</returns>
<param name="appId">
<attribution license="cc4" from="Microsoft" modified="false" />The unique identifier for the application that owns the object.</param>
<param name="type">
<attribution license="cc4" from="Microsoft" modified="false" />The type of the object to create.</param>
<param name="virtualPath">
<attribution license="cc4" from="Microsoft" modified="false" />The virtual path to the application.</param>
<param name="physicalPath">
<attribution license="cc4" from="Microsoft" modified="false" />The physical path to the application.</param>
<param name="failIfExists">
<attribution license="cc4" from="Microsoft" modified="false" />true to throw an exception if an object of the specified type is currently registered; false to return the existing registered object of the specified type.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreateObject">
<MemberSignature Language="C#" Value="public System.Web.Hosting.IRegisteredObject CreateObject (string appId, Type type, string virtualPath, string physicalPath, bool failIfExists, bool throwOnError);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Hosting.IRegisteredObject</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appId" Type="System.String" />
<Parameter Name="type" Type="System.Type" />
<Parameter Name="virtualPath" Type="System.String" />
<Parameter Name="physicalPath" Type="System.String" />
<Parameter Name="failIfExists" Type="System.Boolean" />
<Parameter Name="throwOnError" Type="System.Boolean" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This overload of the <see cref="Overload:System.Web.Hosting.ApplicationManager.CreateObject" /> method provides the <paramref name="throwOnError" /> parameter, which allows you to control whether hosting initialization exceptions are thrown. The overload of the <see cref="Overload:System.Web.Hosting.ApplicationManager.CreateObject" /> method that does not provide <paramref name="throwOnError" /> calls this overload with the parameter set to false.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates an object for the specified application domain based on type, virtual and physical paths, a Boolean value indicating failure behavior when an object of the specified type already exists, and a Boolean value indicating whether hosting initialization error exceptions are thrown.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A new object of the specified <paramref name="type" />.</para>
</returns>
<param name="appId">
<attribution license="cc4" from="Microsoft" modified="false" />The unique identifier for the application that owns the object.</param>
<param name="type">
<attribution license="cc4" from="Microsoft" modified="false" />The type of the object to create.</param>
<param name="virtualPath">
<attribution license="cc4" from="Microsoft" modified="false" />The virtual path to the application.</param>
<param name="physicalPath">
<attribution license="cc4" from="Microsoft" modified="false" />The physical path to the application.</param>
<param name="failIfExists">
<attribution license="cc4" from="Microsoft" modified="false" />true to throw an exception if an object of the specified type is currently registered; false to return the existing registered object of the specified type.</param>
<param name="throwOnError">
<attribution license="cc4" from="Microsoft" modified="false" />true to throw exceptions for hosting initialization errors; false to not throw hosting initialization exceptions.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetApplicationManager">
<MemberSignature Language="C#" Value="public static System.Web.Hosting.ApplicationManager GetApplicationManager ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Hosting.ApplicationManager</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Only one instance of the <see cref="T:System.Web.Hosting.ApplicationManager" /> object is created by an ASP.NET host process in the default application domain. If an instance of the <see cref="T:System.Web.Hosting.ApplicationManager" /> class is not available, the <see cref="M:System.Web.Hosting.ApplicationManager.GetApplicationManager" /> method first creates an instance of the <see cref="T:System.Web.Hosting.ApplicationManager" /> class and then returns the newly created object. If an instance of the <see cref="T:System.Web.Hosting.ApplicationManager" /> class was previously created, the <see cref="M:System.Web.Hosting.ApplicationManager.GetApplicationManager" /> method returns the existing object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the single instance of the <see cref="T:System.Web.Hosting.ApplicationManager" /> object associated with this ASP.NET host process.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The single instance of the <see cref="T:System.Web.Hosting.ApplicationManager" /> object associated with the ASP.NET host process that is running.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetObject">
<MemberSignature Language="C#" Value="public System.Web.Hosting.IRegisteredObject GetObject (string appId, Type type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Hosting.IRegisteredObject</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appId" Type="System.String" />
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the registered object of the specified type from the specified application.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The registered object of the specified type; or null if the type has not been registered through a call to the <see cref="M:System.Web.Hosting.ApplicationManager.CreateObject(System.String,System.Type,System.String,System.String,System.Boolean)" /> method.</para>
</returns>
<param name="appId">
<attribution license="cc4" from="Microsoft" modified="false" />The unique identifier for the application that owns the object.</param>
<param name="type">
<attribution license="cc4" from="Microsoft" modified="false" />The type of the object to return.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetRunningApplications">
<MemberSignature Language="C#" Value="public System.Web.Hosting.ApplicationInfo[] GetRunningApplications ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Hosting.ApplicationInfo[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a snapshot of running applications.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>An array of <see cref="T:System.Web.Hosting.ApplicationInfo" /> objects that contain information about the applications managed by this <see cref="T:System.Web.Hosting.ApplicationManager" /> instance.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="InitializeLifetimeService">
<MemberSignature Language="C#" Value="public override object InitializeLifetimeService ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method overrides the <see cref="M:System.MarshalByRefObject.InitializeLifetimeService" /> method in its base class. It always returns null and thereby prevents a lease from being created that would limit the application domain's lifetime.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gives the application domain an infinite lifetime by preventing a lease from being created.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Always null.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsIdle">
<MemberSignature Language="C#" Value="public bool IsIdle ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Hosting.ApplicationManager.IsIdle" /> method returns true if all applications hosted by the process are idle.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a value indicating whether all applications hosted by the process are idle and not processing requests.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if all applications in the process are idle; otherwise, false.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Open">
<MemberSignature Language="C#" Value="public void Open ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Makes a thread-safe increment to the user reference count of the application manager instance.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ShutdownAll">
<MemberSignature Language="C#" Value="public void ShutdownAll ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Calling the <see cref="M:System.Web.Hosting.ApplicationManager.ShutdownAll" /> method is equivalent to calling the <see cref="M:System.Web.Hosting.HostingEnvironment.InitiateShutdown" /> method in all application domains managed by this <see cref="T:System.Web.Hosting.ApplicationManager" /> instance; however, the <see cref="M:System.Web.Hosting.ApplicationManager.ShutdownAll" /> method can be called from outside the managed application domains.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Unloads all application resources.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ShutdownApplication">
<MemberSignature Language="C#" Value="public void ShutdownApplication (string appId);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appId" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Calling the <see cref="M:System.Web.Hosting.ApplicationManager.ShutdownApplication(System.String)" /> method is equivalent to calling the <see cref="M:System.Web.Hosting.HostingEnvironment.InitiateShutdown" /> method for a specific application domain; however, the <see cref="M:System.Web.Hosting.ApplicationManager.ShutdownApplication(System.String)" /> method can be called from outside managed application domains.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Unloads the specified application.</para>
</summary>
<param name="appId">
<attribution license="cc4" from="Microsoft" modified="false" />The unique identifier of the application to unload.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StopObject">
<MemberSignature Language="C#" Value="public void StopObject (string appId, Type type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="appId" Type="System.String" />
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Removes the specified object from the list of registered objects in an application. If the object to be removed is the last remaining object in the list of registered objects in an application, the application is unloaded.</para>
</summary>
<param name="appId">
<attribution license="cc4" from="Microsoft" modified="false" />The unique identifier for the application that owns the object.</param>
<param name="type">
<attribution license="cc4" from="Microsoft" modified="false" />The type of the object to unload.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

585
mcs/class/System.Web/Documentation/en/System.Web.Hosting/HostingEnvironment.xml Normal file
View File

File diff suppressed because it is too large Load Diff

72
mcs/class/System.Web/Documentation/en/System.Web.Hosting/IAppDomainFactory.xml Normal file
View File

@@ -0,0 +1,72 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IAppDomainFactory" FullName="System.Web.Hosting.IAppDomainFactory">
<TypeSignature Language="C#" Maintainer="auto" Value="public interface IAppDomainFactory" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.Guid("e6e21054-a7dc-4378-877d-b7f4a2d7e8ba")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines a single method to create a new <see cref="T:System.AppDomain" /> instance for a Web application. This interface was used by .NET Framework versions earlier than 2.0; version 2.0 uses the <see cref="T:System.Web.Hosting.IAppManagerAppDomainFactory" /> interface instead.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public object Create (string module, string typeName, string appId, string appPath, string strUrlOfAppOrigin, int iZone);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="module" Type="System.String" />
<Parameter Name="typeName" Type="System.String" />
<Parameter Name="appId" Type="System.String" />
<Parameter Name="appPath" Type="System.String" />
<Parameter Name="strUrlOfAppOrigin" Type="System.String" />
<Parameter Name="iZone" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a new application domain for the specified Web application. This interface was used by .NET Framework versions earlier than 2.0; version 2.0 uses the <see cref="T:System.Web.Hosting.IAppManagerAppDomainFactory" /> interface instead.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A new application domain for the specified Web application.</para>
</returns>
<param name="module">
<attribution license="cc4" from="Microsoft" modified="false" />The module containing the Web application.</param>
<param name="typeName">
<attribution license="cc4" from="Microsoft" modified="false" />The type of the Web application.</param>
<param name="appId">
<attribution license="cc4" from="Microsoft" modified="false" />The unique identifier for the Web application.</param>
<param name="appPath">
<attribution license="cc4" from="Microsoft" modified="false" />The path to the Web application's files.</param>
<param name="strUrlOfAppOrigin">
<attribution license="cc4" from="Microsoft" modified="false" />The URL of origin for the Web application.</param>
<param name="iZone">
<attribution license="cc4" from="Microsoft" modified="false" />The zone of origin for the Web application.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

74
mcs/class/System.Web/Documentation/en/System.Web.Hosting/IAppManagerAppDomainFactory.xml Normal file
View File

@@ -0,0 +1,74 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IAppManagerAppDomainFactory" FullName="System.Web.Hosting.IAppManagerAppDomainFactory">
<TypeSignature Language="C#" Value="public interface IAppManagerAppDomainFactory" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.Guid("02998279-7175-4D59-AA5A-FB8E44D4CA9D")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines a method used to create an <see cref="T:System.AppDomain" /> instance for a Web-application manager and a method used to stop all <see cref="T:System.AppDomain" /> instances for a Web-application manager.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Create">
<MemberSignature Language="C#" Value="public object Create (string s, string app_id);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="s" Type="System.String" />
<Parameter Name="app_id" Type="System.String" />
</Parameters>
<Docs>
<param name="s">To be added.</param>
<param name="app_id">To be added.</param>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a new application domain for the specified Web application.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A new application domain for the specified Web application.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Stop">
<MemberSignature Language="C#" Value="public void Stop ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Stops all application domains associated with this application manager. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

117
mcs/class/System.Web/Documentation/en/System.Web.Hosting/IISAPIRuntime.xml Normal file
View File

@@ -0,0 +1,117 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IISAPIRuntime" FullName="System.Web.Hosting.IISAPIRuntime">
<TypeSignature Language="C#" Maintainer="auto" Value="public interface IISAPIRuntime" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsIUnknown)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.Guid("08A2C56F-7C16-41C1-A8BE-432917A1A2D1")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines the methods that are used to create <see cref="T:System.Web.HttpWorkerRequest" /> objects in the .NET Framework.</para>
</summary>
</Docs>
<Members>
<Member MemberName="DoGCCollect">
<MemberSignature Language="C#" Value="public void DoGCCollect ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Forces garbage collection.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ProcessRequest">
<MemberSignature Language="C#" Value="public int ProcessRequest (IntPtr ecb, int useProcessModel);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="ecb" Type="System.IntPtr" />
<Parameter Name="useProcessModel" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a new <see cref="T:System.Web.HttpWorkerRequest" /> object to process the current request.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>0 if <see cref="T:System.Web.HttpWorkerRequest" /> was created successfully; otherwise, 1.</para>
</returns>
<param name="ecb">
<attribution license="cc4" from="Microsoft" modified="false" />An ISAPI extension control block.</param>
<param name="useProcessModel">
<attribution license="cc4" from="Microsoft" modified="false" />0 to create an out-of-process request; otherwise, an in-process request is created.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StartProcessing">
<MemberSignature Language="C#" Value="public void StartProcessing ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Starts processing all items in the worker process pipeline.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StopProcessing">
<MemberSignature Language="C#" Value="public void StopProcessing ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Stops processing the items in the worker process pipeline.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

53
mcs/class/System.Web/Documentation/en/System.Web.Hosting/IRegisteredObject.xml Normal file
View File

@@ -0,0 +1,53 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="IRegisteredObject" FullName="System.Web.Hosting.IRegisteredObject">
<TypeSignature Language="C#" Value="public interface IRegisteredObject" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Objects must implement the <see cref="T:System.Web.Hosting.IRegisteredObject" /> interface in order to register with the hosting environment and have their lifetime managed by the hosting environment.</para>
<para>You can create an instance of a registered object by calling the <see cref="M:System.Web.Hosting.ApplicationManager.CreateObject(System.String,System.Type,System.String,System.String,System.Boolean)" /> method on the application manager. The application manager returns the newly created object to the caller, which can then call a type-specific method on the object. During startup, the registered object should call the <see cref="M:System.Web.Hosting.HostingEnvironment.RegisterObject(System.Web.Hosting.IRegisteredObject)" /> method to complete registration of the object.</para>
<para>When the application manager needs to stop a registered object, it will call the <see cref="M:System.Web.Hosting.IRegisteredObject.Stop(System.Boolean)" /> method. </para>
<para>Applications can have only one instance of a registered type. To create multiple instances of a registered type, use the factory pattern to create an object manager that is registered with the application and then manages the multiple instances. For an example of an object implementing the factory pattern, see the example for the <see cref="T:System.Web.Hosting.ApplicationManager" /> class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Defines methods for objects that are managed by the hosting environment.</para>
</summary>
</Docs>
<Members>
<Member MemberName="Stop">
<MemberSignature Language="C#" Value="public void Stop (bool immediate);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="immediate" Type="System.Boolean" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The application manager will call the <see cref="M:System.Web.Hosting.IRegisteredObject.Stop(System.Boolean)" /> method to ask a registered object to unregister. During processing of the <see cref="M:System.Web.Hosting.IRegisteredObject.Stop(System.Boolean)" /> method, the registered object must call the <see cref="M:System.Web.Hosting.HostingEnvironment.UnregisterObject(System.Web.Hosting.IRegisteredObject)" /> method. </para>
<para>The <see cref="M:System.Web.Hosting.IRegisteredObject.Stop(System.Boolean)" /> method is first called with the <paramref name="immediate" /> parameter set to false. The object can either complete processing, call the <see cref="M:System.Web.Hosting.HostingEnvironment.UnregisterObject(System.Web.Hosting.IRegisteredObject)" /> method, and then return or it can return immediately and complete processing asynchronously before calling the <see cref="M:System.Web.Hosting.HostingEnvironment.UnregisterObject(System.Web.Hosting.IRegisteredObject)" /> method.</para>
<para>If the registered object does not complete processing before the application manager's time-out period expires, the <see cref="M:System.Web.Hosting.IRegisteredObject.Stop(System.Boolean)" /> method is called again with the <paramref name="immediate" /> parameter set to true. When the <paramref name="immediate" /> parameter is true, the registered object must call the <see cref="M:System.Web.Hosting.HostingEnvironment.UnregisterObject(System.Web.Hosting.IRegisteredObject)" /> method before returning; otherwise, its registration will be removed by the application manager.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Requests a registered object to unregister.</para>
</summary>
<param name="immediate">
<attribution license="cc4" from="Microsoft" modified="false" />true to indicate the registered object should unregister from the hosting environment before returning; otherwise, false.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

180
mcs/class/System.Web/Documentation/en/System.Web.Hosting/ISAPIRuntime.xml Normal file
View File

@@ -0,0 +1,180 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ISAPIRuntime" FullName="System.Web.Hosting.ISAPIRuntime">
<TypeSignature Language="C#" Maintainer="auto" Value="public sealed class ISAPIRuntime : MarshalByRefObject, System.Web.Hosting.IISAPIRuntime, System.Web.Hosting.IRegisteredObject" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Base>
<BaseTypeName>System.MarshalByRefObject</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Web.Hosting.IISAPIRuntime</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Web.Hosting.IRegisteredObject</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Manages <see cref="T:System.Web.HttpWorkerRequest" /> objects in the .NET Framework. This class cannot be inherited.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ISAPIRuntime ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Hosting.ISAPIRuntime" /> class. </para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DoGCCollect">
<MemberSignature Language="C#" Value="public void DoGCCollect ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Forces garbage collection.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="InitializeLifetimeService">
<MemberSignature Language="C#" Value="public override object InitializeLifetimeService ();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gives the <see cref="T:System.Web.Hosting.ISAPIRuntime" /> object an infinite lifetime by preventing a lease from being created. </para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>null to prevent a lease from being created.</para>
</returns>
</Docs>
</Member>
<Member MemberName="ProcessRequest">
<MemberSignature Language="C#" Value="public int ProcessRequest (IntPtr ecb, int iWRType);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="ecb" Type="System.IntPtr" />
<Parameter Name="iWRType" Type="System.Int32" />
</Parameters>
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a new <see cref="T:System.Web.HttpWorkerRequest" /> object to process the current request.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>0 if <see cref="T:System.Web.HttpWorkerRequest" /> was created successfully; otherwise, 1.</para>
</returns>
<param name="ecb">
<attribution license="cc4" from="Microsoft" modified="false" />An ISAPI extension control block.</param>
<param name="iWRType">
<attribution license="cc4" from="Microsoft" modified="false" />0 to create an out-of-process request; otherwise, an in-process request is created.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StartProcessing">
<MemberSignature Language="C#" Value="public void StartProcessing ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Starts processing all items in the worker process pipeline.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="StopProcessing">
<MemberSignature Language="C#" Value="public void StopProcessing ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>To be added</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Stops processing the items in the worker process pipeline.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="System.Web.Hosting.IRegisteredObject.Stop">
<MemberSignature Language="C#" Value="void IRegisteredObject.Stop (bool immediate);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="immediate" Type="System.Boolean" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Requests a registered object to unregister.</para>
</summary>
<param name="immediate">
<attribution license="cc4" from="Microsoft" modified="false" />true to indicate that the registered object should unregister from the hosting environment before returning; otherwise, false.</param>
</Docs>
</Member>
</Members>
</Type>

759
mcs/class/System.Web/Documentation/en/System.Web.Hosting/SimpleWorkerRequest.xml Normal file
View File

File diff suppressed because it is too large Load Diff

130
mcs/class/System.Web/Documentation/en/System.Web.Hosting/VirtualDirectory.xml Normal file
View File

@@ -0,0 +1,130 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="VirtualDirectory" FullName="System.Web.Hosting.VirtualDirectory">
<TypeSignature Language="C#" Value="public abstract class VirtualDirectory : System.Web.Hosting.VirtualFileBase" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.Hosting.VirtualFileBase</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Hosting.VirtualDirectory" /> class is the base class for objects that represent directories in a virtual file system. Typically, you would implement a descendent of the <see cref="T:System.Web.Hosting.VirtualDirectory" /> class for each <see cref="T:System.Web.Hosting.VirtualPathProvider" /> class descendent in your Web application.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents a directory object in a virtual file or resource space.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected VirtualDirectory (string virtualPath);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="virtualPath" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Hosting.VirtualDirectory" /> class. </para>
</summary>
<param name="virtualPath">
<attribution license="cc4" from="Microsoft" modified="false" />The virtual path to the resource represented by this instance.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Children">
<MemberSignature Language="C#" Value="public abstract System.Collections.IEnumerable Children { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IEnumerable</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Hosting.VirtualDirectory.Children" /> property contains both <see cref="T:System.Web.Hosting.VirtualFile" /> and <see cref="T:System.Web.Hosting.VirtualDirectory" /> objects that represent the files and directories contained in this virtual directory. To return only the <see cref="T:System.Web.Hosting.VirtualFile" /> objects, use the <see cref="P:System.Web.Hosting.VirtualDirectory.Files" /> property. To return only the <see cref="T:System.Web.Hosting.VirtualDirectory" /> objects, use the <see cref="P:System.Web.Hosting.VirtualDirectory.Directories" /> property.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a list of the files and subdirectories contained in this virtual directory.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Directories">
<MemberSignature Language="C#" Value="public abstract System.Collections.IEnumerable Directories { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IEnumerable</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Hosting.VirtualDirectory.Directories" /> property contains <see cref="T:System.Web.Hosting.VirtualDirectory" /> objects that represent the directories contained in this virtual directory. To return the <see cref="T:System.Web.Hosting.VirtualFile" /> objects, use the <see cref="P:System.Web.Hosting.VirtualDirectory.Files" /> property. To return both <see cref="T:System.Web.Hosting.VirtualFile" /> and <see cref="T:System.Web.Hosting.VirtualDirectory" /> objects, use the <see cref="P:System.Web.Hosting.VirtualDirectory.Children" /> property.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a list of all the subdirectories contained in this directory.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Files">
<MemberSignature Language="C#" Value="public abstract System.Collections.IEnumerable Files { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IEnumerable</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Hosting.VirtualDirectory.Files" /> property contains <see cref="T:System.Web.Hosting.VirtualFile" /> objects that represent the files contained in this virtual directory. To return the <see cref="T:System.Web.Hosting.VirtualDirectory" /> objects, use the <see cref="P:System.Web.Hosting.VirtualDirectory.Directories" /> property. To return both <see cref="T:System.Web.Hosting.VirtualFile" /> and <see cref="T:System.Web.Hosting.VirtualDirectory" /> objects, use the <see cref="P:System.Web.Hosting.VirtualDirectory.Children" /> property.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a list of all files contained in this directory.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsDirectory">
<MemberSignature Language="C#" Value="public override bool IsDirectory { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value that indicates that this is a virtual resource that should be treated as a directory.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

90
mcs/class/System.Web/Documentation/en/System.Web.Hosting/VirtualFile.xml Normal file
View File

@@ -0,0 +1,90 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="VirtualFile" FullName="System.Web.Hosting.VirtualFile">
<TypeSignature Language="C#" Value="public abstract class VirtualFile : System.Web.Hosting.VirtualFileBase" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.Hosting.VirtualFileBase</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Hosting.VirtualFile" /> class is the base class for objects that represent files in a virtual file system. Typically, you would implement a descendent of the <see cref="T:System.Web.Hosting.VirtualFile" /> class for each <see cref="T:System.Web.Hosting.VirtualPathProvider" /> object descendent in your Web application.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents a file object in a virtual file or resource space.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected VirtualFile (string virtualPath);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="virtualPath" Type="System.String" />
</Parameters>
<Docs>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.Hosting.VirtualFile" /> class. </para>
</summary>
<param name="virtualPath">
<attribution license="cc4" from="Microsoft" modified="false" />The virtual path to the resource represented by this instance. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsDirectory">
<MemberSignature Language="C#" Value="public override bool IsDirectory { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value that indicates that this is a virtual resource that should be treated as a file.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Open">
<MemberSignature Language="C#" Value="public abstract System.IO.Stream Open ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.IO.Stream</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Hosting.VirtualFile.Open" /> method returns a stream containing the data treated as a file by the <see cref="T:System.Web.Hosting.VirtualPathProvider" /> class. The stream is read-only and is seekable (the <see cref="P:System.IO.Stream.CanSeek" /> property is true).</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived class, returns a read-only stream to the virtual resource.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A read-only stream to the virtual file.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

133
mcs/class/System.Web/Documentation/en/System.Web.Hosting/VirtualFileBase.xml Normal file
View File

@@ -0,0 +1,133 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="VirtualFileBase" FullName="System.Web.Hosting.VirtualFileBase">
<TypeSignature Language="C#" Value="public abstract class VirtualFileBase : MarshalByRefObject" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.MarshalByRefObject</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Hosting.VirtualFileBase" /> abstract class provides the common methods and properties shared between the <see cref="T:System.Web.Hosting.VirtualFile" /> and <see cref="T:System.Web.Hosting.VirtualDirectory" /> objects. Implementations of these classes provide the ASP.NET runtime with access to files and paths used for compilation. For more information on using virtual files and paths, see the <see cref="T:System.Web.Hosting.VirtualPathProvider" /> class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides the core implementation for the <see cref="T:System.Web.Hosting.VirtualFile" /> and <see cref="T:System.Web.Hosting.VirtualDirectory" /> objects. An abstract class, it cannot be instantiated.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected VirtualFileBase ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Although you cannot directly construct an instance of the <see cref="T:System.Web.Hosting.VirtualFileBase" /> class, you can call this constructor from the constructor of an inheriting class. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes the class for use by an inherited class instance. This constructor can be called only by an inherited class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="InitializeLifetimeService">
<MemberSignature Language="C#" Value="public override object InitializeLifetimeService ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method overrides the <see cref="M:System.MarshalByRefObject.InitializeLifetimeService" /> method on its base class. It always returns null and thereby prevents a lease from being created that would limit the lifetime of the virtual file or directory.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gives a <see cref="T:System.Web.Hosting.VirtualFileBase" /> instance an infinite lifetime by preventing a lease from being created.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Always null.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="IsDirectory">
<MemberSignature Language="C#" Value="public abstract bool IsDirectory { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overridden in a derived class, gets a value indicating whether the <see cref="T:System.Web.Hosting.VirtualFileBase" /> instance represents a virtual file or a virtual directory.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public virtual string Name { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Hosting.VirtualFileBase.Name" /> property is typically the file name and extension associated with the resource, although virtual resources may use arbitrary names. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the display name of the virtual resource.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="VirtualPath">
<MemberSignature Language="C#" Value="public string VirtualPath { get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="P:System.Web.Hosting.VirtualFileBase.VirtualPath" /> property returns the path to the file or directory represented by this object. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the virtual file path.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>

447
mcs/class/System.Web/Documentation/en/System.Web.Hosting/VirtualPathProvider.xml Normal file
View File

@@ -0,0 +1,447 @@
<?xml version="1.0" encoding="utf-8"?>
<Type Name="VirtualPathProvider" FullName="System.Web.Hosting.VirtualPathProvider">
<TypeSignature Language="C#" Value="public abstract class VirtualPathProvider : MarshalByRefObject" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.MarshalByRefObject</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.Web.Hosting.VirtualPathProvider" /> class provides a set of methods for implementing a virtual file system for a Web application. In a virtual file system, the files and directories are managed by a data store other than the file system provided by the server's operating system. For example, you can use a virtual file system to store content in a SQL Server database.</para>
<para>You can store any file that is processed on request in a virtual file system. This includes:</para>
<list type="bullet">
<item>
<para>ASP.NET pages, master pages, user controls, and other objects.</para>
</item>
<item>
<para>Standard Web pages with extensions such as .htm and .jpg.</para>
</item>
<item>
<para>Any custom extension mapped to a <see cref="T:System.Web.Compilation.BuildProvider" /> instance.</para>
</item>
<item>
<para>Any named theme in the App_Theme folder.</para>
</item>
</list>
<para>You cannot store ASP.NET application folders or files that generate application-level assemblies in a virtual file system. This includes:</para>
<list type="bullet">
<item>
<para>The Global.asax file.</para>
</item>
<item>
<para>Web.config files.</para>
</item>
<item>
<para>Site map data files used by the <see cref="T:System.Web.XmlSiteMapProvider" />.</para>
</item>
<item>
<para>Directories that contain application assemblies or that generate application assemblies: Bin, App_Code, App_GlobalResources, any App_LocalResources.</para>
</item>
<item>
<para>The application data folder, App_Data.</para>
</item>
</list>
<block subset="none" type="note">
<para>If a Web site is precompiled for deployment, content provided by a <see cref="T:System.Web.Hosting.VirtualPathProvider" /> instance is not compiled, and no <see cref="T:System.Web.Hosting.VirtualPathProvider" /> instances are used by the precompiled site.</para>
</block>
<format type="text/html">
<h2>Registering a VirtualPathProvider</h2>
</format>
<para>A custom <see cref="T:System.Web.Hosting.VirtualPathProvider" /> instance should be registered with the ASP.NET compilation system by using the <see cref="M:System.Web.Hosting.HostingEnvironment.RegisterVirtualPathProvider(System.Web.Hosting.VirtualPathProvider)" /> method before any page parsing or compilation is performed by the Web application.</para>
<para>Typically, a <see cref="T:System.Web.Hosting.VirtualPathProvider" /> instance is registered in an AppInitialize method defined in the App_Code directory, or during the Application_Start event in the Global.asax file. For an example of registering a <see cref="T:System.Web.Hosting.VirtualPathProvider" /> instance in an AppInitialize method, see the Example section.</para>
<para>You can register a <see cref="T:System.Web.Hosting.VirtualPathProvider" /> instance during other events, but pages compiled and cached before the <see cref="T:System.Web.Hosting.VirtualPathProvider" /> instance is registered will not be invalidated, even if the new <see cref="T:System.Web.Hosting.VirtualPathProvider" /> instance would now provide the source for the previously compiled page.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Provides a set of methods that enable a Web application to retrieve resources from a virtual file system.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected VirtualPathProvider ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When overriding the <see cref="M:System.Web.Hosting.VirtualPathProvider.#ctor" /> constructor, defer any initialization that must occur after the <see cref="T:System.Web.Hosting.VirtualPathProvider" /> object is registered to the <see cref="M:System.Web.Hosting.VirtualPathProvider.Initialize" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes the class for use by an inherited class instance. This constructor can be called only by an inherited class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CombineVirtualPaths">
<MemberSignature Language="C#" Value="public virtual string CombineVirtualPaths (string basePath, string relativePath);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="basePath" Type="System.String" />
<Parameter Name="relativePath" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="M:System.Web.Hosting.VirtualPathProvider.CombineVirtualPaths(System.String,System.String)" /> method to inspect the contents of a relative path to a virtual resource and perform any modifications required. </para>
<para>The default implementation combines the <paramref name="basePath" /> and <paramref name="relativePath" /> parameters according to standard ASP.NET path processing. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Combines a base path with a relative path to return a complete path to a virtual resource.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The complete path to a virtual resource.</para>
</returns>
<param name="basePath">
<attribution license="cc4" from="Microsoft" modified="false" />The base path for the application.</param>
<param name="relativePath">
<attribution license="cc4" from="Microsoft" modified="false" />The path to the virtual resource, relative to the base path.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DirectoryExists">
<MemberSignature Language="C#" Value="public virtual bool DirectoryExists (string virtualDir);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="virtualDir" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Override the <see cref="M:System.Web.Hosting.VirtualPathProvider.DirectoryExists(System.String)" /> method to indicate to the compilation system that the resource represented by <paramref name="virtualDir" /> exists in the virtual file system provided by this <see cref="T:System.Web.Hosting.VirtualPathProvider" /> instance.</para>
<para>If your custom <see cref="T:System.Web.Hosting.VirtualPathProvider" /> class does not support directories, the <see cref="M:System.Web.Hosting.VirtualPathProvider.DirectoryExists(System.String)" /> method should return false.</para>
<block subset="none" type="note">
<para>If your virtual file system will contain themes for the Web site (by creating a virtual App_Themes directory), your custom <see cref="T:System.Web.Hosting.VirtualPathProvider" /> class must support directories.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value that indicates whether a directory exists in the virtual file system.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the directory exists in the virtual file system; otherwise, false.</para>
</returns>
<param name="virtualDir">
<attribution license="cc4" from="Microsoft" modified="false" />The path to the virtual directory.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="FileExists">
<MemberSignature Language="C#" Value="public virtual bool FileExists (string virtualPath);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="virtualPath" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Override the <see cref="M:System.Web.Hosting.VirtualPathProvider.FileExists(System.String)" /> method to indicate to the compilation system that the resource represented by <paramref name="virtualPath" /> exists in the virtual file system provided by this <see cref="T:System.Web.Hosting.VirtualPathProvider" /> instance.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value that indicates whether a file exists in the virtual file system.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if the file exists in the virtual file system; otherwise, false.</para>
</returns>
<param name="virtualPath">
<attribution license="cc4" from="Microsoft" modified="false" />The path to the virtual file.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetCacheDependency">
<MemberSignature Language="C#" Value="public virtual System.Web.Caching.CacheDependency GetCacheDependency (string virtualPath, System.Collections.IEnumerable virtualPathDependencies, DateTime utcStart);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Caching.CacheDependency</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="virtualPath" Type="System.String" />
<Parameter Name="virtualPathDependencies" Type="System.Collections.IEnumerable" />
<Parameter Name="utcStart" Type="System.DateTime" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The default implementation of the <see cref="M:System.Web.Hosting.VirtualPathProvider.GetCacheDependency(System.String,System.Collections.IEnumerable,System.DateTime)" /> method returns null. To cache virtual resources for later use you must override either the <see cref="M:System.Web.Hosting.VirtualPathProvider.GetCacheDependency(System.String,System.Collections.IEnumerable,System.DateTime)" /> method or the <see cref="M:System.Web.Hosting.VirtualPathProvider.GetFileHash(System.String,System.Collections.IEnumerable)" /> method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Creates a cache dependency based on the specified virtual paths.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A <see cref="T:System.Web.Caching.CacheDependency" /> object for the specified virtual resources.</para>
</returns>
<param name="virtualPath">
<attribution license="cc4" from="Microsoft" modified="false" />The path to the primary virtual resource.</param>
<param name="virtualPathDependencies">
<attribution license="cc4" from="Microsoft" modified="false" />An array of paths to other resources required by the primary virtual resource.</param>
<param name="utcStart">
<attribution license="cc4" from="Microsoft" modified="false" />The UTC time at which the virtual resources were read.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetCacheKey">
<MemberSignature Language="C#" Value="public virtual string GetCacheKey (string virtualPath);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="virtualPath" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="M:System.Web.Hosting.VirtualPathProvider.GetCacheKey(System.String)" /> method to provide a custom cache key for virtual resources. If you do not override the <see cref="M:System.Web.Hosting.VirtualPathProvider.GetCacheKey(System.String)" /> method, the virtual path is used for the cache key.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a cache key to use for the specified virtual path.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A cache key for the specified virtual resource.</para>
</returns>
<param name="virtualPath">
<attribution license="cc4" from="Microsoft" modified="false" />The path to the virtual resource.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetDirectory">
<MemberSignature Language="C#" Value="public virtual System.Web.Hosting.VirtualDirectory GetDirectory (string virtualDir);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Hosting.VirtualDirectory</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="virtualDir" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Hosting.VirtualPathProvider.GetDirectory(System.String)" /> method returns a descendent of the <see cref="T:System.Web.Hosting.VirtualDirectory" /> class that contains the file and directories contained in the directory specified in the <paramref name="virtualDir" /> parameter.</para>
<para>If your custom <see cref="T:System.Web.Hosting.VirtualPathProvider" /> class does not support directories, the <see cref="M:System.Web.Hosting.VirtualPathProvider.GetDirectory(System.String)" /> method should return null.</para>
<block subset="none" type="note">
<para>If your virtual file system will contain themes for the Web site (by creating a virtual App_Themes directory), your custom <see cref="T:System.Web.Hosting.VirtualPathProvider" /> class must support directories.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a virtual directory from the virtual file system.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A descendent of the <see cref="T:System.Web.Hosting.VirtualDirectory" /> class that represents a directory in the virtual file system.</para>
</returns>
<param name="virtualDir">
<attribution license="cc4" from="Microsoft" modified="false" />The path to the virtual directory.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetFile">
<MemberSignature Language="C#" Value="public virtual System.Web.Hosting.VirtualFile GetFile (string virtualPath);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.Hosting.VirtualFile</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="virtualPath" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Hosting.VirtualPathProvider.GetFile(System.String)" /> method returns a descendent of the <see cref="T:System.Web.Hosting.VirtualFile" /> class that represents the file specified by the <paramref name="virtualPath" /> parameter.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a virtual file from the virtual file system.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A descendent of the <see cref="T:System.Web.Hosting.VirtualFile" /> class that represents a file in the virtual file system.</para>
</returns>
<param name="virtualPath">
<attribution license="cc4" from="Microsoft" modified="false" />The path to the virtual file.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="GetFileHash">
<MemberSignature Language="C#" Value="public virtual string GetFileHash (string virtualPath, System.Collections.IEnumerable virtualPathDependencies);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="virtualPath" Type="System.String" />
<Parameter Name="virtualPathDependencies" Type="System.Collections.IEnumerable" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="M:System.Web.Hosting.VirtualPathProvider.GetFileHash(System.String,System.Collections.IEnumerable)" /> method to provide a hash of the dependencies for a virtual-file-system resource. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a hash of the specified virtual paths.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A hash of the specified virtual paths.</para>
</returns>
<param name="virtualPath">
<attribution license="cc4" from="Microsoft" modified="false" />The path to the primary virtual resource.</param>
<param name="virtualPathDependencies">
<attribution license="cc4" from="Microsoft" modified="false" />An array of paths to other virtual resources required by the primary virtual resource.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="protected virtual void Initialize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Hosting.VirtualPathProvider.Initialize" /> method is called after the provider is registered with the ASP.NET compilation system. The <see cref="M:System.Web.Hosting.VirtualPathProvider.Initialize" /> method is used to provide any initialization required after the <see cref="T:System.Web.Hosting.VirtualPathProvider" /> instance is placed into the environment the application occupies.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes the <see cref="T:System.Web.Hosting.VirtualPathProvider" /> instance.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="InitializeLifetimeService">
<MemberSignature Language="C#" Value="public override object InitializeLifetimeService ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This method overrides the <see cref="M:System.MarshalByRefObject.InitializeLifetimeService" /> method in its base class. It always returns null and thereby prevents a lease from being created that would limit the <see cref="T:System.Web.Hosting.VirtualPathProvider" /> object's lifetime.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gives the <see cref="T:System.Web.Hosting.VirtualPathProvider" /> object an infinite lifetime by preventing a lease from being created.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Always null.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="OpenFile">
<MemberSignature Language="C#" Value="public static System.IO.Stream OpenFile (string virtualPath);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.IO.Stream</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="virtualPath" Type="System.String" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.Hosting.VirtualPathProvider.OpenFile(System.String)" /> method is a convenience method that enables you to get a stream from a virtual file without creating a <see cref="T:System.Web.Hosting.VirtualPathProvider" /> instance. </para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a stream from a virtual file.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A read-only <see cref="T:System.IO.Stream" /> object for the specified virtual file or resource.</para>
</returns>
<param name="virtualPath">
<attribution license="cc4" from="Microsoft" modified="false" />The path to the virtual file.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Previous">
<MemberSignature Language="C#" Value="protected System.Web.Hosting.VirtualPathProvider Previous { get; }" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.Hosting.VirtualPathProvider</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>When a <see cref="T:System.Web.Hosting.VirtualPathProvider" /> object is registered with the ASP.NET compilation system, it is added to a chain of providers. Use the <see cref="P:System.Web.Hosting.VirtualPathProvider.Previous" /> property to hand processing off to the previous <see cref="T:System.Web.Hosting.VirtualPathProvider" /> object in the chain if the requested path is not provided by this <see cref="T:System.Web.Hosting.VirtualPathProvider" /> instance.</para>
<para>The chain of path providers always ends with the default ASP.NET provider, which serves files from the file system.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a reference to a previously registered <see cref="T:System.Web.Hosting.VirtualPathProvider" /> object in the compilation system.</para>
</summary>
</Docs>
</Member>
</Members>
</Type>