Compartilhar via

WebConfigurationManager.GetSection Método

  • Referência

Definição

Namespace:
System.Web.Configuration
Assembly:
System.Web.dll

Recupera a seção de configuração especificada do arquivo de configuração padrão do aplicativo Web atual.

Sobrecargas

GetSection(String)

Recupera a seção de configuração especificada do arquivo de configuração do aplicativo Web atual.
GetSection(String, String)

Recupera a seção de configuração especificada do arquivo de configuração do aplicativo Web no local especificado.

GetSection(String)

Recupera a seção de configuração especificada do arquivo de configuração do aplicativo Web atual.

public:
 static System::Object ^ GetSection(System::String ^ sectionName);
public static object GetSection (string sectionName);
static member GetSection : string -> obj
Public Shared Function GetSection (sectionName As String) As Object

Parâmetros

sectionName
String

O nome da seção de configuração.

Retornos

Object

O objeto de seção de configuração especificado ou null se a seção não existir. Lembre-se de que as restrições de segurança existem ao usar GetSection(String) como uma operação de runtime. Você não poderá acessar uma seção no tempo de execução para realizar modificações, por exemplo.

Exceções

ConfigurationErrorsException

Não foi possível carregar um arquivo de configuração válido.

Exemplos

Os exemplos nesta seção mostram como acessar informações de configuração com o GetSection método.

O exemplo a seguir mostra uma seção que pode ser acessada de um aplicativo Web ou de um aplicativo de console.

Observação

Este exemplo demonstra como usar o GetWebApplicationSection método para obter um ConfigurationSection objeto de um arquivo de configuração.


// Show how to use the GetSection(string). 
// to access the connectionStrings section.
static void GetConnectionStringsSection()
{

    // Get the connectionStrings section.
    ConnectionStringsSection connectionStringsSection =
        WebConfigurationManager.GetSection("connectionStrings")
        as ConnectionStringsSection;

    // Get the connectionStrings key,value pairs collection.
    ConnectionStringSettingsCollection connectionStrings =
        connectionStringsSection.ConnectionStrings;
   
    // Get the collection enumerator.
    IEnumerator connectionStringsEnum =
        connectionStrings.GetEnumerator();

    // Loop through the collection and 
    // display the connectionStrings key, value pairs.
    int i = 0;
    Console.WriteLine("[Display the connectionStrings]");
    while (connectionStringsEnum.MoveNext())
    {
        string name = connectionStrings[i].Name;
        Console.WriteLine("Name: {0} Value: {1}",
        name, connectionStrings[name]);
        i += 1;
    }

    Console.WriteLine();
}

' Show how to use the GetSection(string). 
' to access the connectionStrings section.
Shared Sub GetConnectionStringsSection()
   
   ' Get the connectionStrings section.
     Dim connectionStringsSection As ConnectionStringsSection = _
     WebConfigurationManager.GetSection("connectionStrings")
   
   ' Get the connectionStrings key,value pairs collection.
     Dim connectionStrings As ConnectionStringSettingsCollection = _
     connectionStringsSection.ConnectionStrings
   
   ' Get the collection enumerator.
     Dim connectionStringsEnum As IEnumerator = _
     connectionStrings.GetEnumerator()
   
   ' Loop through the collection and 
   ' display the connectionStrings key, value pairs.
   Dim i As Integer = 0
   Console.WriteLine("[Display the connectionStrings]")
   While connectionStringsEnum.MoveNext()
      Dim name As String = connectionStrings(i).Name
         Console.WriteLine("Name: {0} Value: {1}", _
         name, connectionStrings(name))
      i += 1
   End While
   
   Console.WriteLine()
End Sub

Comentários

Se GetSection for chamado de dentro de um aplicativo Web, ele obterá a seção do arquivo de configuração selecionado pelo sistema de acordo com a hierarquia de configuração do aplicativo Web.

Cuidado

Se o aplicativo usa um protocolo diferente de HTTP, a GetSection sobrecarga que usa um nome de seção e um caminho em sua lista de parâmetros é a que deve ser usada. Você deve especificar o caminho do arquivo de configuração porque o sistema não pode fazer suposições sobre o nível da hierarquia de configuração. Se você usar a GetSection sobrecarga que usa apenas um nome de seção, o sistema sempre tentará retornar as configurações no nível do aplicativo. Observe, porém, que se o caminho especificado estiver fora do aplicativo atual, a sobrecarga que usa um caminho também retornará as configurações no nível do aplicativo para o aplicativo em execução no momento.

Você pode chamar GetSection de dentro de um aplicativo cliente. Nesse caso, ele obtém a seção padrão do arquivo de configuração selecionado pelo sistema de acordo com a hierarquia de configuração do cliente. Normalmente, esse é o arquivo Machine.config, a menos que você tenha uma configuração mapeada em vigor. Para mapear arquivos de configuração, consulte os métodos de mapeamento descritos a seguir.

Observação

O GetSection método é um método de tempo de execução que opera na seção de um arquivo de configuração no nível de hierarquia no qual o aplicativo é executado. Para uma operação sem tempo de execução, use GetSection em vez disso. Esse método opera na seção especificada de um arquivo de configuração obtido usando um dos métodos sobrecarregados para abrir um arquivo de configuração. OpenWebConfiguration

Notas aos Herdeiros

O valor retornado deve ser convertido no tipo de configuração esperado antes do uso. Para evitar possíveis exceções de conversão, você deve usar uma operação de conversão condicional como o as operador em C#.

Confira também

Aplica-se a

GetSection(String, String)

Recupera a seção de configuração especificada do arquivo de configuração do aplicativo Web no local especificado.

public:
 static System::Object ^ GetSection(System::String ^ sectionName, System::String ^ path);
public static object GetSection (string sectionName, string path);
static member GetSection : string * string -> obj
Public Shared Function GetSection (sectionName As String, path As String) As Object

Parâmetros

sectionName
String

O nome da seção de configuração.

path
String

O caminho do arquivo de configuração virtual.

Retornos

Object

O objeto de seção de configuração especificado ou null se a seção não existir. Lembre-se de que as restrições de segurança existem ao usar GetSection(String, String) como uma operação de tempo de execução. Você não poderá acessar uma seção no tempo de execução para realizar modificações, por exemplo.

Exceções

InvalidOperationException

O método é chamado de fora de um aplicativo Web.

ConfigurationErrorsException

Não foi possível carregar um arquivo de configuração válido.

Exemplos

O exemplo a seguir mostra como acessar informações de configuração com o GetSection método.

Observação

Este exemplo demonstra como usar o GetSection método para obter um ConfigurationSection objeto de um arquivo de configuração especificado.


// Show the use of GetSection(string, string). 
// to access the connectionStrings section.
 static void GetSection2()
 {

     try
     {
         // Get the connectionStrings section for the 
         // specified Web app. This GetSection overload
         // can olny be called from within a Web application.
         ConnectionStringsSection connectionStringsSection =
             WebConfigurationManager.GetSection("connectionStrings",
             "/configTest") as ConnectionStringsSection;

         // Get the connectionStrings key,value pairs collection
         ConnectionStringSettingsCollection connectionStrings =
             connectionStringsSection.ConnectionStrings;

         // Get the collection enumerator.
         IEnumerator connectionStringsEnum =
             connectionStrings.GetEnumerator();

         // Loop through the collection and 
         // display the connectionStrings key, value pairs.
         int i = 0;
         Console.WriteLine("[Display connectionStrings]");
         while (connectionStringsEnum.MoveNext())
         {
             string name = connectionStrings[i].Name;
             Console.WriteLine("Name: {0} Value: {1}",
             name, connectionStrings[name]);
             i += 1;
         }
         Console.WriteLine();
     }

     catch (InvalidOperationException e)
     {
         string errorMsg = e.ToString();
         Console.WriteLine(errorMsg);
     }
 }

' Show the use of GetSection(string, string). 
' to access the connectionStrings section.
Shared Sub GetSection2()
   
   Try
      ' Get the connectionStrings section for the 
      ' specified Web app. This GetSection overload
      ' can olny be called from within a Web application.
         Dim connectionStringsSection As ConnectionStringsSection = _
         WebConfigurationManager.GetSection( _
         "connectionStrings", "/configTest")
      
      ' Get the connectionStrings key,value pairs collection
         Dim connectionStrings As ConnectionStringSettingsCollection = _
         connectionStringsSection.ConnectionStrings
      
      ' Get the collection enumerator.
         Dim connectionStringsEnum As IEnumerator = _
         connectionStrings.GetEnumerator()
      
      ' Loop through the collection and 
      ' display the connectionStrings key, value pairs.
      Dim i As Integer = 0
      Console.WriteLine("[Display connectionStrings]")
      While connectionStringsEnum.MoveNext()
         Dim name As String = connectionStrings(i).Name
             Console.WriteLine("Name: {0} Value: {1}", _
             name, connectionStrings(name))
         i += 1
      End While
      Console.WriteLine()
   
   Catch e As InvalidOperationException
      Dim errorMsg As String = e.ToString()
      Console.WriteLine(errorMsg)
   End Try
End Sub

Comentários

Se GetSection for chamado de dentro de um aplicativo Web, ele obterá a seção do arquivo de configuração definido pelo caminho especificado na hierarquia de configuração.

Cuidado

Se o aplicativo usa um protocolo diferente de HTTP, a GetSection sobrecarga que usa um nome de seção e um caminho em sua lista de parâmetros é a que deve ser usada. Você deve especificar o caminho do arquivo de configuração porque o sistema não pode fazer suposições sobre o nível da hierarquia de configuração. Se você usar a GetSection sobrecarga que usa apenas um nome de seção, o sistema sempre tentará retornar as configurações no nível do aplicativo. Observe, porém, que se o caminho especificado estiver fora do aplicativo atual, a sobrecarga que usa um caminho também retornará as configurações no nível do aplicativo para o aplicativo em execução no momento.

Esse método não pode ser chamado de dentro de um aplicativo cliente.

Se você quiser recuperar a seção de configuração do arquivo de configuração localizado no nível atual do diretório do aplicativo Web, use o GetSection método.

Observação

O GetSection método é um método de tempo de execução que opera na seção de um arquivo de configuração no nível de hierarquia no qual o aplicativo é executado. Para uma operação sem tempo de execução, use GetSection em vez disso. Esse método opera na seção especificada de um arquivo de configuração obtido usando um dos métodos de arquivo de open configuração.

Notas aos Herdeiros

O valor retornado deve ser convertido no tipo de configuração esperado antes do uso. Para evitar possíveis exceções de conversão, você deve usar uma operação de conversão condicional como o as operador em C#.

Confira também

Aplica-se a