HostingEnvironmentSection Classe
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Define definições de configuração que controlam o comportamento do ambiente de alojamento da aplicação. Esta classe não pode ser herdada.
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
- Herança
Exemplos
Este exemplo demonstra como especificar valores declarativamente para vários atributos da secção hostingEnvironment Element (ASP.NET Settings Schema), que também podem ser acedidos como membros da classe HostingEnvironmentSection.
O exemplo seguinte de ficheiro de configuração mostra como especificar valores declarativamente para a secção hostingEnvironment Element (ASP.NET Settings Schema).
<system.web>
<hostingEnvironment
idleTimeout="20"
shutdownTimeout="30"
/>
</system.web>
O exemplo de código seguinte demonstra como usar a HostingEnvironmentSection classe.
#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
Observações
A classe HostingEnvironmentSection fornece uma forma de aceder e modificar programaticamente os valores da secção HostingEnvironmentSection no ficheiro de configuração. Quando uma aplicação ASP.NET está inutilizada durante um período de tempo especificado, pode ser descarregada da memória com base nas propriedades IdleTimeout e ShutdownTimeout.
Construtores
| Name | Description |
|---|---|
| HostingEnvironmentSection() |
Inicializa uma nova instância da HostingEnvironmentSection classe usando as definições padrão. |
Propriedades
| Name | Description |
|---|---|
| CurrentConfiguration |
Obtém uma referência à instância de topo Configuration que representa a hierarquia de configuração a que pertence a instância atual ConfigurationElement . (Herdado de ConfigurationElement) |
| ElementInformation |
Obtém um ElementInformation objeto que contém a informação e funcionalidade não personalizáveis do ConfigurationElement objeto. (Herdado de ConfigurationElement) |
| ElementProperty |
Obtém o ConfigurationElementProperty objeto que representa o ConfigurationElement próprio objeto. (Herdado de ConfigurationElement) |
| EvaluationContext |
Obtém o ContextInformation objeto para o ConfigurationElement objeto. (Herdado de ConfigurationElement) |
| HasContext |
Obtém um valor que indica se a CurrentConfiguration propriedade é |
| IdleTimeout |
Obtém ou define o tempo, em minutos, antes de descarregar uma aplicação inativa. |
| Item[ConfigurationProperty] |
Obtém ou define uma propriedade ou atributo deste elemento de configuração. (Herdado de ConfigurationElement) |
| Item[String] |
Obtém ou define uma propriedade, atributo ou elemento filho deste elemento de configuração. (Herdado de ConfigurationElement) |
| LockAllAttributesExcept |
Obtém a coleção de atributos bloqueados. (Herdado de ConfigurationElement) |
| LockAllElementsExcept |
Obtém a coleção de elementos bloqueados. (Herdado de ConfigurationElement) |
| LockAttributes |
Obtém a coleção de atributos bloqueados. (Herdado de ConfigurationElement) |
| LockElements |
Obtém a coleção de elementos bloqueados. (Herdado de ConfigurationElement) |
| LockItem |
Recebe ou define um valor que indica se o elemento está bloqueado. (Herdado de ConfigurationElement) |
| Properties |
Recebe a coleção de propriedades. (Herdado de ConfigurationElement) |
| SectionInformation |
Obtém um SectionInformation objeto que contém a informação e funcionalidade não personalizáveis do ConfigurationSection objeto. (Herdado de ConfigurationSection) |
| ShadowCopyBinAssemblies |
Recebe ou define um valor que indica se os assemblies de uma aplicação no Bin são copiados em sombra para o diretório ASP.NET Temporary Files da aplicação. |
| ShutdownTimeout |
Obtém ou define o tempo, em segundos, para desligar a aplicação de forma elegante. |
| UrlMetadataSlidingExpiration |
Obtém ou define um valor que determina como o ASP.NET armazena em cache os metadados do URL. |
Métodos
| Name | Description |
|---|---|
| DeserializeElement(XmlReader, Boolean) |
Lê XML a partir do ficheiro de configuração. (Herdado de ConfigurationElement) |
| DeserializeSection(XmlReader) |
Lê XML a partir do ficheiro de configuração. (Herdado de ConfigurationSection) |
| Equals(Object) |
Compara a instância atual ConfigurationElement com o objeto especificado. (Herdado de ConfigurationElement) |
| GetHashCode() |
Obtém um valor único que representa a instância atual ConfigurationElement . (Herdado de ConfigurationElement) |
| GetRuntimeObject() |
Devolve um objeto personalizado quando sobrescrito numa classe derivada. (Herdado de ConfigurationSection) |
| GetTransformedAssemblyString(String) |
Devolve a versão transformada do nome da assembleia especificado. (Herdado de ConfigurationElement) |
| GetTransformedTypeString(String) |
Devolve a versão transformada do nome do tipo especificado. (Herdado de ConfigurationElement) |
| GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
| Init() |
Define o ConfigurationElement objeto para o seu estado inicial. (Herdado de ConfigurationElement) |
| InitializeDefault() |
Usado para inicializar um conjunto padrão de valores para o ConfigurationElement objeto. (Herdado de ConfigurationElement) |
| IsModified() |
Indica se este elemento de configuração foi modificado desde a última vez que foi guardado ou carregado quando implementado numa classe derivada. (Herdado de ConfigurationSection) |
| IsReadOnly() |
Recebe um valor que indica se o ConfigurationElement objeto é apenas de leitura. (Herdado de ConfigurationElement) |
| ListErrors(IList) |
Adiciona os erros de propriedades inválidas neste ConfigurationElement objeto, e em todos os subelementos, à lista passada. (Herdado de ConfigurationElement) |
| MemberwiseClone() |
Cria uma cópia superficial do atual Object. (Herdado de Object) |
| OnDeserializeUnrecognizedAttribute(String, String) |
Recebe um valor que indica se um atributo desconhecido é encontrado durante a desserialização. (Herdado de ConfigurationElement) |
| OnDeserializeUnrecognizedElement(String, XmlReader) |
Obtém um valor que indica se um elemento desconhecido é encontrado durante a desserialização. (Herdado de ConfigurationElement) |
| OnRequiredPropertyNotFound(String) |
Lança uma exceção quando uma propriedade exigida não é encontrada. (Herdado de ConfigurationElement) |
| PostDeserialize() |
Chamada após desserialização. (Herdado de ConfigurationElement) |
| PreSerialize(XmlWriter) |
Chamado antes da serialização. (Herdado de ConfigurationElement) |
| Reset(ConfigurationElement) |
Reinicia o estado interno do ConfigurationElement objeto, incluindo os bloqueios e as coleções de propriedades. (Herdado de ConfigurationElement) |
| ResetModified() |
Redefine o valor do IsModified() método para |
| SerializeElement(XmlWriter, Boolean) |
Escreve o conteúdo deste elemento de configuração no ficheiro de configuração quando implementado numa classe derivada. (Herdado de ConfigurationElement) |
| SerializeSection(ConfigurationElement, String, ConfigurationSaveMode) |
Cria uma string XML contendo uma vista não fundida do ConfigurationSection objeto como uma única secção para escrever num ficheiro. (Herdado de ConfigurationSection) |
| SerializeToXmlElement(XmlWriter, String) |
Escreve as etiquetas exteriores deste elemento de configuração no ficheiro de configuração quando implementado numa classe derivada. (Herdado de ConfigurationElement) |
| SetPropertyValue(ConfigurationProperty, Object, Boolean) |
Define uma propriedade para o valor especificado. (Herdado de ConfigurationElement) |
| SetReadOnly() |
Define a IsReadOnly() propriedade para o ConfigurationElement objeto e todos os subelementos. (Herdado de ConfigurationElement) |
| ShouldSerializeElementInTargetVersion(ConfigurationElement, String, FrameworkName) |
Indica se o elemento especificado deve ser serializado quando a hierarquia de objetos de configuração é serializada para a versão alvo especificada do .NET Framework. (Herdado de ConfigurationSection) |
| ShouldSerializePropertyInTargetVersion(ConfigurationProperty, String, FrameworkName, ConfigurationElement) |
Indica se a propriedade especificada deve ser serializada quando a hierarquia de objetos de configuração é serializada para a versão alvo especificada do .NET Framework. (Herdado de ConfigurationSection) |
| ShouldSerializeSectionInTargetVersion(FrameworkName) |
Indica se a instância atual ConfigurationSection deve ser serializada quando a hierarquia de objetos de configuração é serializada para a versão alvo especificada do .NET Framework. (Herdado de ConfigurationSection) |
| ToString() |
Devolve uma cadeia que representa o objeto atual. (Herdado de Object) |
| Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode) |
Modifica o ConfigurationElement objeto para remover todos os valores que não deveriam ser guardados. (Herdado de ConfigurationElement) |