HostingEnvironmentSection Clase

Definición

Define opciones de configuración que controlan el comportamiento del entorno de host de la aplicación.Defines configuration settings that control the behavior of the application hosting environment. Esta clase no puede heredarse.This class cannot be inherited.

public ref class HostingEnvironmentSection sealed : System::Configuration::ConfigurationSection
public sealed class HostingEnvironmentSection : System.Configuration.ConfigurationSection
type HostingEnvironmentSection = class
    inherit ConfigurationSection
Public NotInheritable Class HostingEnvironmentSection
Inherits ConfigurationSection
Herencia

Ejemplos

En este ejemplo se muestra cómo especificar valores de forma declarativa para varios atributos de la sección HostingEnvironment Element (esquema de configuración de ASP.net) , a los que también se puede tener acceso como miembros de la HostingEnvironmentSection clase.This example demonstrates how to specify values declaratively for several attributes of the hostingEnvironment Element (ASP.NET Settings Schema) section, which can also be accessed as members of the HostingEnvironmentSection class.

En el siguiente ejemplo de archivo de configuración se muestra cómo especificar valores de forma declarativa para la sección HostingEnvironment Element (esquema de configuración de ASP.net) .The following configuration file example shows how to specify values declaratively for the hostingEnvironment Element (ASP.NET Settings Schema) section.

<system.web>  
  <hostingEnvironment  
    idleTimeout="20"  
    shutdownTimeout="30"  
  />  
</system.web>  

En el ejemplo de código siguiente se muestra cómo utilizar la HostingEnvironmentSection clase.The following code example demonstrates how to use the HostingEnvironmentSection class.

#region Using directives

using System;
using System.Collections.Generic;
using System.Text;
using System.Configuration;
using System.Web;
using System.Web.Configuration;

#endregion

namespace Samples.Aspnet.SystemWebConfiguration
{
  class UsingHostingEnvironmentSection
  {
    static void Main(string[] args)
    {
      try
      {
        // Set the path of the config file.
        string configPath = "";
 
        // Get the Web application configuration object.
        Configuration config = WebConfigurationManager.OpenWebConfiguration(configPath);

        // Get the section related object.
        HostingEnvironmentSection configSection = 
          (HostingEnvironmentSection)config.GetSection("system.web/hostingEnvironment");

        // Display title and info.
        Console.WriteLine("ASP.NET Configuration Info");
        Console.WriteLine();

        // Display Config details.
        Console.WriteLine("File Path: {0}", config.FilePath);
        Console.WriteLine("Section Path: {0}", configSection.SectionInformation.Name);

        // Display IdleTimout property
        Console.WriteLine("Idle Timeout: {0}", configSection.IdleTimeout);

        // Set IdleTimout property
        configSection.IdleTimeout = TimeSpan.FromMinutes(40);

        // Display ShutdownTimeout property
        Console.WriteLine("Shutdown Timeout: {0}", configSection.ShutdownTimeout);

        // Set ShutdownTimeout property
        configSection.ShutdownTimeout = TimeSpan.FromSeconds(60);

        // Update if not locked.
        if (!configSection.SectionInformation.IsLocked)
        {
          config.Save();
          Console.WriteLine("** Configuration updated.");
        }
        else
        {
          Console.WriteLine("** Could not update, section is locked.");
        }
      }
      catch (Exception e)
        {
          // Unknown error.
          Console.WriteLine(e.ToString());
        }

      // Display and wait
      Console.ReadLine();
    }
  }
}
Imports System.Collections.Generic
Imports System.Text
Imports System.Configuration
Imports System.Web
Imports System.Web.Configuration

Namespace Samples.Aspnet.SystemWebConfiguration
  Class UsingSiteMapSection
    Public Shared Sub Main()
      Try
        ' Set the path of the config file.
        Dim configPath As String = ""

        ' Get the Web application configuration object.
        Dim config As System.Configuration.Configuration = _
         System.Web.Configuration.WebConfigurationManager.OpenWebConfiguration(configPath)

        ' Get the section related object.
        Dim configSection As System.Web.Configuration.HostingEnvironmentSection = _
         CType(config.GetSection("system.web/hostingEnvironment"), System.Web.Configuration.HostingEnvironmentSection)

        ' Display title and info.
        Console.WriteLine("ASP.NET Configuration Info")
        Console.WriteLine()

        ' Display Config details.
        Console.WriteLine("File Path: {0}", config.FilePath)
        Console.WriteLine("Section Path: {0}", configSection.SectionInformation.Name)

        ' Display the IdleTimout property
        Console.WriteLine("Idle Timeout: {0}", configSection.IdleTimeout)

        ' Set the IdleTimout property
        configSection.IdleTimeout = TimeSpan.FromMinutes(40)

        ' Display the ShutdownTimeout property
        Console.WriteLine("Shutdown Timeout: {0}", configSection.ShutdownTimeout)

        ' Set the ShutdownTimeout property
        configSection.ShutdownTimeout = TimeSpan.FromSeconds(60)

        ' Update if not locked.
        If Not configSection.SectionInformation.IsLocked Then
          config.Save()
          Console.WriteLine("** Configuration updated.")
        Else
          Console.WriteLine("** Could not update, section is locked.")
        End If

      Catch e As Exception
        ' Unknown error.
        Console.WriteLine(e.ToString())
      End Try

      ' Display and wait
      Console.ReadLine()
    End Sub
  End Class
End Namespace

Comentarios

La HostingEnvironmentSection clase proporciona una manera de obtener acceso y modificar mediante programación los valores de la HostingEnvironmentSection sección del archivo de configuración. Cuando una aplicación ASP.NET no se usa durante un período de tiempo especificado, se puede descargar de la memoria en función de las IdleTimeout propiedades y ShutdownTimeout .The HostingEnvironmentSection class provides a way to programmatically access and modify the values of the HostingEnvironmentSection section in the configuration file.When an ASP.NET application is unused for a specified amount of time, it can be unloaded from memory based on the IdleTimeout and ShutdownTimeout properties.

Constructores

HostingEnvironmentSection()

Inicializa una nueva instancia de la clase HostingEnvironmentSection utilizando las opciones predeterminadas.Initializes a new instance of the HostingEnvironmentSection class by using default settings.

Propiedades

CurrentConfiguration

Obtiene una referencia a la instancia de Configuration de nivel superior que representa la jerarquía de configuración a la que pertenece la instancia actual de ConfigurationElement.Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to.

(Heredado de ConfigurationElement)
ElementInformation

Obtiene un objeto ElementInformation que contiene la funcionalidad e información no personalizable del objeto ConfigurationElement.Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object.

(Heredado de ConfigurationElement)
ElementProperty

Obtiene el objeto ConfigurationElementProperty que representa al propio objeto ConfigurationElement.Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself.

(Heredado de ConfigurationElement)
EvaluationContext

Obtiene el objeto ContextInformation para el objeto ConfigurationElement.Gets the ContextInformation object for the ConfigurationElement object.

(Heredado de ConfigurationElement)
HasContext

Obtiene un valor que indica si la propiedad CurrentConfiguration es null.Gets a value that indicates whether the CurrentConfiguration property is null.

(Heredado de ConfigurationElement)
IdleTimeout

Obtiene o establece el período de tiempo, en minutos, antes de descargar una aplicación inactiva.Gets or sets the amount of time, in minutes, before unloading an inactive application.

Item[ConfigurationProperty]

Obtiene o establece una propiedad o atributo de este elemento de configuración.Gets or sets a property or attribute of this configuration element.

(Heredado de ConfigurationElement)
Item[String]

Obtiene o establece una propiedad, un atributo o un elemento secundario de este elemento de configuración.Gets or sets a property, attribute, or child element of this configuration element.

(Heredado de ConfigurationElement)
LockAllAttributesExcept

Obtiene la colección de atributos bloqueados.Gets the collection of locked attributes.

(Heredado de ConfigurationElement)
LockAllElementsExcept

Obtiene la colección de elementos bloqueados.Gets the collection of locked elements.

(Heredado de ConfigurationElement)
LockAttributes

Obtiene la colección de atributos bloqueados.Gets the collection of locked attributes.

(Heredado de ConfigurationElement)
LockElements

Obtiene la colección de elementos bloqueados.Gets the collection of locked elements.

(Heredado de ConfigurationElement)
LockItem

Obtiene o establece un valor que indica si el elemento está bloqueado.Gets or sets a value indicating whether the element is locked.

(Heredado de ConfigurationElement)
Properties

Obtiene la colección de propiedades.Gets the collection of properties.

(Heredado de ConfigurationElement)
SectionInformation

Obtiene un objeto SectionInformation que contiene la funcionalidad e información no personalizable del objeto ConfigurationSection.Gets a SectionInformation object that contains the non-customizable information and functionality of the ConfigurationSection object.

(Heredado de ConfigurationSection)
ShadowCopyBinAssemblies

Obtiene o establece un valor que indica si se realizan copias sombra de los ensamblados de una aplicación del directorio Bin en el directorio de archivos temporales ASP.NET de la aplicación.Gets or sets a value indicating whether the assemblies of an application in Bin are shadow copied to the application's ASP.NET Temporary Files directory.

ShutdownTimeout

Obtiene o establece el período de tiempo, en segundos, para cerrar la aplicación correctamente.Gets or sets the amount of time, in seconds, to gracefully shut down the application.

UrlMetadataSlidingExpiration

Obtiene o establece un valor que determina cómo ASP.NET almacena en memoria caché los metadatos de la dirección URL.Gets or sets a value that determines how ASP.NET caches URL metadata.

Métodos

DeserializeElement(XmlReader, Boolean)

Lee XML del archivo de configuración.Reads XML from the configuration file.

(Heredado de ConfigurationElement)
DeserializeSection(XmlReader)

Lee XML del archivo de configuración.Reads XML from the configuration file.

(Heredado de ConfigurationSection)
Equals(Object)

Compara la instancia actual de ConfigurationElement con el objeto especificado.Compares the current ConfigurationElement instance to the specified object.

(Heredado de ConfigurationElement)
GetHashCode()

Obtiene un valor único que representa la instancia actual de ConfigurationElement.Gets a unique value representing the current ConfigurationElement instance.

(Heredado de ConfigurationElement)
GetRuntimeObject()

Devuelve un objeto personalizado cuando se reemplaza en una clase derivada.Returns a custom object when overridden in a derived class.

(Heredado de ConfigurationSection)
GetTransformedAssemblyString(String)

Devuelve la versión transformada del nombre de ensamblado especificado.Returns the transformed version of the specified assembly name.

(Heredado de ConfigurationElement)
GetTransformedTypeString(String)

Devuelve la versión transformada del nombre de tipo especificado.Returns the transformed version of the specified type name.

(Heredado de ConfigurationElement)
GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Heredado de Object)
Init()

Establece el objeto ConfigurationElement en su estado inicial.Sets the ConfigurationElement object to its initial state.

(Heredado de ConfigurationElement)
InitializeDefault()

Se utiliza para inicializar un conjunto predeterminado de valores para el objeto ConfigurationElement.Used to initialize a default set of values for the ConfigurationElement object.

(Heredado de ConfigurationElement)
IsModified()

Indica si se ha modificado este elemento de configuración desde la última vez en que se guardo o cargó al implementarlo en una clase derivada.Indicates whether this configuration element has been modified since it was last saved or loaded when implemented in a derived class.

(Heredado de ConfigurationSection)
IsReadOnly()

Obtiene un valor que indica si el objeto ConfigurationElement es de solo lectura.Gets a value indicating whether the ConfigurationElement object is read-only.

(Heredado de ConfigurationElement)
ListErrors(IList)

Agrega a la lista que se pasa los errores de propiedad no válida que hay en este objeto ConfigurationElement y en todos los subelementos.Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list.

(Heredado de ConfigurationElement)
MemberwiseClone()

Crea una copia superficial del Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
OnDeserializeUnrecognizedAttribute(String, String)

Obtiene un valor que indica si se ha encontrado un atributo desconocido durante la deserialización.Gets a value indicating whether an unknown attribute is encountered during deserialization.

(Heredado de ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)

Obtiene un valor que indica si se ha encontrado un elemento desconocido durante la deserialización.Gets a value indicating whether an unknown element is encountered during deserialization.

(Heredado de ConfigurationElement)
OnRequiredPropertyNotFound(String)

Se inicia una excepción cuando no se encuentra una propiedad necesaria.Throws an exception when a required property is not found.

(Heredado de ConfigurationElement)
PostDeserialize()

Se llama a este método después de la deserialización.Called after deserialization.

(Heredado de ConfigurationElement)
PreSerialize(XmlWriter)

Se llama a este método antes de la serialización.Called before serialization.

(Heredado de ConfigurationElement)
Reset(ConfigurationElement)

Restablece el estado interno del objeto ConfigurationElement, incluyendo los bloqueos y las colecciones de propiedades.Resets the internal state of the ConfigurationElement object, including the locks and the properties collections.

(Heredado de ConfigurationElement)
ResetModified()

Restablece el valor del método IsModified() en false cuando se implementa en una clase derivada.Resets the value of the IsModified() method to false when implemented in a derived class.

(Heredado de ConfigurationSection)
SerializeElement(XmlWriter, Boolean)

Escribe el contenido de este elemento de configuración en el archivo de configuración cuando se implementa en una clase derivada.Writes the contents of this configuration element to the configuration file when implemented in a derived class.

(Heredado de ConfigurationElement)
SerializeSection(ConfigurationElement, String, ConfigurationSaveMode)

Crea una cadena XML que contiene una vista separada del objeto ConfigurationSection como una sección única para escribir en un archivo.Creates an XML string containing an unmerged view of the ConfigurationSection object as a single section to write to a file.

(Heredado de ConfigurationSection)
SerializeToXmlElement(XmlWriter, String)

Escribe las etiquetas externas de este elemento de configuración en el archivo de configuración cuando se implementa en una clase derivada.Writes the outer tags of this configuration element to the configuration file when implemented in a derived class.

(Heredado de ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)

Establece una propiedad en el valor especificado.Sets a property to the specified value.

(Heredado de ConfigurationElement)
SetReadOnly()

Establece la propiedad IsReadOnly() para el objeto ConfigurationElement y todos los subelementos.Sets the IsReadOnly() property for the ConfigurationElement object and all subelements.

(Heredado de ConfigurationElement)
ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName)

Indica si se debe serializar el elemento especificado cuando la jerarquía de objetos de configuración se serializa para la versión de destino especificada de .NET Framework.NET Framework.Indicates whether the specified element should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.NET Framework.

(Heredado de ConfigurationSection)
ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement)

Indica si se debe serializar la propiedad especificada cuando la jerarquía de objetos de configuración se serializa para la versión de destino especificada de .NET Framework.NET Framework.Indicates whether the specified property should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.NET Framework.

(Heredado de ConfigurationSection)
ShouldSerializeSectionInTargetVersion(FrameworkName)

Indica si se debe serializar la instancia actual de ConfigurationSection cuando la jerarquía de objetos de configuración se serializa para la versión de destino especificada de .NET Framework.NET Framework.Indicates whether the current ConfigurationSection instance should be serialized when the configuration object hierarchy is serialized for the specified target version of the .NET Framework.NET Framework.

(Heredado de ConfigurationSection)
ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Heredado de Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

Modifica el objeto ConfigurationElement para quitar todos los valores que no se deben guardar.Modifies the ConfigurationElement object to remove all values that should not be saved.

(Heredado de ConfigurationElement)

Se aplica a

Consulte también