1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 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>
|