WebConfigurationManager.GetSection Método

Definição

Recupera a seção de configuração especificada do arquivo de configuração padrão do aplicativo Web atual.Retrieves the specified configuration section from the current Web application's default configuration file.

Sobrecargas

GetSection(String)

Recupera a seção de configuração especificada do arquivo de configuração do aplicativo Web atual.Retrieves the specified configuration section from the current Web application's configuration file.

GetSection(String, String)

Recupera a seção de configuração especificada do arquivo de configuração do aplicativo Web no local especificado.Retrieves the specified configuration section from the Web application's configuration file at the specified location.

GetSection(String)

Recupera a seção de configuração especificada do arquivo de configuração do aplicativo Web atual.Retrieves the specified configuration section from the current Web application's configuration file.

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.The configuration section name.

Retornos

O objeto de seção de configuração especificado ou null se a seção não existir.The specified configuration section object, or null if the section does not exist. Lembre-se de que as restrições de segurança existem ao usar GetSection(String) como uma operação de tempo de execução.Remember that security restrictions exist on the use of GetSection(String) as a runtime operation. Você não poderá acessar uma seção no tempo de execução para realizar modificações, por exemplo.You might not be able to access a section at run time for modifications, for example.

Exceções

Não foi possível carregar um arquivo de configuração válido.A valid configuration file could not be loaded.

Exemplos

Os exemplos nesta seção mostram como acessar informações de configuração com o GetSection método.The examples in this section show how to access configuration information with the GetSection method.

O exemplo a seguir mostra uma seção que pode ser acessada por meio de um aplicativo Web ou de um aplicativo de console.The following example shows a section that can be accessed from either a Web application or a console application.

Observação

Este exemplo demonstra como usar o GetWebApplicationSection método para obter um ConfigurationSection objeto de um arquivo de configuração.This example demonstrates how to use the GetWebApplicationSection method to get a ConfigurationSection object from a configuration file.


// 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 de aplicativo Web.If GetSection is called from within a Web application, it gets the section from the configuration file selected by the system according to the Web-application configuration hierarchy.

Cuidado

Se seu aplicativo usar um protocolo diferente do http, a GetSection sobrecarga que usa um nome de seção e um caminho em sua lista de parâmetros é aquela a ser usada.If your application uses a different protocol than HTTP, the GetSection overload that takes both a section name and a path in its parameter list is the one to use. 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.You must specify the configuration file path because the system cannot make any assumptions about the configuration hierarchy level. Se você usar a GetSection sobrecarga que usa apenas um nome de seção, o sistema sempre tentará retornar as definições de configuração no nível do aplicativo.If you use the GetSection overload that takes only a section name, the system will always attempt to return the configuration settings at the application level. Observe, no entanto, que, se o caminho especificado estiver fora do aplicativo atual, a sobrecarga que usa um caminho também retornará as definições de configuração de nível de aplicativo para o aplicativo em execução no momento.Note, though, that if its specified path is outside of the current application, the overload that takes a path will also return the application-level configuration settings for the currently running application.

Você pode chamar GetSection de dentro de um aplicativo cliente.You could call GetSection from within a client application. 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.In this case, it gets the default section from the configuration file selected by the system according to the client configuration hierarchy. Normalmente, esse é o arquivo Machine. config, a menos que você tenha uma configuração mapeada no local.Usually, this is the Machine.config file, unless you have a mapped configuration in place. Para mapear arquivos de configuração, consulte os métodos de mapeamento descritos em Avançar.For mapping configuration files, refer to the mapping methods described next.

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.The GetSection method is a run-time method that operates on the section of a configuration file at the hierarchy level in which the application runs. Para uma operação que não seja de tempo de execução GetSection , use em vez disso.For a non-run-time operation, use GetSection instead. Esse método opera na seção especificada de um arquivo de configuração que você obtém usando um dos métodos sobrecarregados para abrir um arquivo de configuração, OpenWebConfiguration.This method operates on the specified section of a configuration file that you obtain using one of the overloaded methods for opening a configuration file, OpenWebConfiguration.

Notas aos Herdeiros

O valor de retorno deve ser convertido para o tipo de configuração esperado antes de usar.The return value must be cast to the expected configuration type before use. Para evitar possíveis exceções de conversão, você deve usar uma operação de conversão condicional as como o C# operador in ou a função no Visual Basic.To avoid possible casting exceptions, you should use a conditional casting operation like the as operator in C# or the function in Visual Basic.

Veja também

GetSection(String, String)

Recupera a seção de configuração especificada do arquivo de configuração do aplicativo Web no local especificado.Retrieves the specified configuration section from the Web application's configuration file at the specified location.

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.The configuration section name.

path
String

O caminho do arquivo de configuração virtual.The virtual configuration file path.

Retornos

O objeto de seção de configuração especificado ou null se a seção não existir.The specified configuration section object, or null if the section does not exist. 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.Remember that security restrictions exist on the use of GetSection(String, String) as a run-time operation. Você não poderá acessar uma seção no tempo de execução para realizar modificações, por exemplo.You might not be able to access a section at run time for modifications, for instance.

Exceções

O método é chamado de fora de um aplicativo Web.The method is called from outside a Web application.

Não foi possível carregar um arquivo de configuração válido.A valid configuration file could not be loaded.

Exemplos

O exemplo a seguir mostra como acessar as informações de configuração GetSection com o método.The following example shows how to access configuration information with the GetSection method.

Observação

Este exemplo demonstra como usar o GetSection método para obter um ConfigurationSection objeto de um arquivo de configuração especificado.This example demonstrates how to use the GetSection method to get a ConfigurationSection object from a specified configuration file.


// 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.If GetSection is called from within a Web application, it gets the section from the configuration file defined by the specified path in the configuration hierarchy.

Cuidado

Se seu aplicativo usar um protocolo diferente do http, a GetSection sobrecarga que usa um nome de seção e um caminho em sua lista de parâmetros é aquela a ser usada.If your application uses a different protocol than HTTP, the GetSection overload that takes both a section name and a path in its parameter list is the one to use. 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.You must specify the configuration file path because the system cannot make any assumptions about the configuration hierarchy level. Se você usar a GetSection sobrecarga que usa apenas um nome de seção, o sistema sempre tentará retornar as definições de configuração no nível do aplicativo.If you use the GetSection overload that takes only a section name, the system will always attempt to return the configuration settings at the application level. Observe, no entanto, que, se o caminho especificado estiver fora do aplicativo atual, a sobrecarga que usa um caminho também retornará as definições de configuração de nível de aplicativo para o aplicativo em execução no momento.Note, though, that if its specified path is outside of the current application, the overload that takes a path will also return the application-level configuration settings for the currently running application.

Este método não pode ser chamado de dentro de um aplicativo cliente.This method cannot be called from within a client application.

Se você quiser recuperar a seção de configuração do arquivo de configuração localizado no nível do diretório do aplicativo Web atual, use GetSection o método.If you want to retrieve the configuration section from the configuration file located at the current Web application directory level, use the GetSection method.

Observação

O GetSection método é um método de tempo de execução operando na seção de um arquivo de configuração no nível de hierarquia no qual o aplicativo é executado.The GetSection method is a run-time method operating on the section of a configuration file at the hierarchy level in which the application runs. Para uma operação que não seja de tempo de execução GetSection , use em vez disso.For a non-run-time operation, use GetSection instead. Esse método opera na seção especificada de um arquivo de configuração que você obtém usando um dos métodos open de arquivo de configuração.This method operates on the specified section of a configuration file that you obtain using one of the open configuration file methods.

Notas aos Herdeiros

O valor de retorno deve ser convertido para o tipo de configuração esperado antes de usar.The return value must be cast to the expected configuration type before use. Para evitar possíveis exceções de conversão, você deve usar uma operação de conversão condicional as como o C# operador in ou a função no Visual Basic.To avoid possible casting exceptions, you should use a conditional casting operation like the as operator in C# or the function in Visual Basic.

Veja também

Aplica-se a