WebConfigurationManager.GetSection WebConfigurationManager.GetSection WebConfigurationManager.GetSection WebConfigurationManager.GetSection Method

定義

現在の Web アプリケーションの既定の構成ファイルの、指定した構成セクションを取得します。Retrieves the specified configuration section from the current Web application's default configuration file.

オーバーロード

GetSection(String) GetSection(String) GetSection(String) GetSection(String)

現在の Web アプリケーションの構成ファイルの、指定した構成セクションを取得します。Retrieves the specified configuration section from the current Web application's configuration file.

GetSection(String, String) GetSection(String, String) GetSection(String, String) GetSection(String, String)

指定された場所にある Web アプリケーションの構成ファイルの、指定した構成セクションを取得します。Retrieves the specified configuration section from the Web application's configuration file at the specified location.

GetSection(String) GetSection(String) GetSection(String) GetSection(String)

現在の Web アプリケーションの構成ファイルの、指定した構成セクションを取得します。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

パラメーター

sectionName
String String String String

構成セクション名。The configuration section name.

戻り値

指定した構成セクション オブジェクト。指定したセクションが存在しない場合は nullThe specified configuration section object, or null if the section does not exist. GetSection(String) を実行時の操作として使用する場合は、セキュリティ上の制限に注意してください。Remember that security restrictions exist on the use of GetSection(String) as a runtime operation. たとえば、実行時には変更のためにセクションにアクセスできない場合があります。You might not be able to access a section at run time for modifications, for example.

例外

有効な構成ファイルを読み込むことができませんでした。A valid configuration file could not be loaded.

このセクションの例では、使用して構成情報にアクセスする方法を表示、GetSectionメソッド。The examples in this section show how to access configuration information with the GetSection method.

次の例では、Web アプリケーションまたはコンソール アプリケーションからアクセス可能なセクションを示します。The following example shows a section that can be accessed from either a Web application or a console application.

注意

使用する方法を示します、GetWebApplicationSectionを取得するメソッド、ConfigurationSection構成ファイルからのオブジェクト。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 'GetSection1


注釈

場合GetSectionが呼び出されますから、Web アプリケーション内でそのセクションを取得します、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.

注意事項

アプリケーションは、HTTP 以外のプロトコルを使用する場合、GetSectionのパラメーター リストのセクションの名前とパスの両方を受け取るオーバー ロードは、1 つを使用します。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. システムが構成階層のレベルについてどのような想定できないために、構成ファイルのパスを指定する必要があります。You must specify the configuration file path because the system cannot make any assumptions about the configuration hierarchy level. 使用する場合、GetSectionのみセクション名、システムを取るオーバー ロードは常にしようとすると、アプリケーション レベルで構成設定を返します。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. ただし、こと、指定したパスが現在のアプリケーションの外部である場合は、パスを取るオーバー ロードを返すことも、現在実行中のアプリケーションのアプリケーション レベルの構成設定に注意してください。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.

呼び出すことがGetSectionからクライアント アプリケーション内で。You could call GetSection from within a client application. この場合、クライアント構成の階層構造に従って、システムによって選択された構成ファイルから既定のセクションを取得します。In this case, it gets the default section from the configuration file selected by the system according to the client configuration hierarchy. 通常、場所にマップされた構成がない限り、Machine.config ファイルになります。Usually, this is the Machine.config file, unless you have a mapped configuration in place. 構成ファイルのマッピング、マッピング メソッドを次に説明を参照してください。For mapping configuration files, refer to the mapping methods described next.

注意

GetSectionメソッドは、アプリケーションを実行する階層レベルの構成ファイルのセクションで動作する実行時メソッドです。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. 操作では実行時以外を使用して、GetSection代わりにします。For a non-run-time operation, use GetSection instead. このメソッドは、構成ファイルを開くためのオーバー ロードされたメソッドのいずれかを使用して取得する構成ファイルの指定したセクションでは動作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.

注意 (継承者)

戻り値は、使用する前に必要な構成型にキャストする必要があります。The return value must be cast to the expected configuration type before use. 可能性のあるキャスト例外を回避するには、条件付きのキャスト操作などを使用する必要があります、 as c# または 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.

こちらもご覧ください

GetSection(String, String) GetSection(String, String) GetSection(String, String) GetSection(String, String)

指定された場所にある Web アプリケーションの構成ファイルの、指定した構成セクションを取得します。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

パラメーター

sectionName
String String String String

構成セクション名。The configuration section name.

path
String String String String

仮想構成ファイル パス。The virtual configuration file path.

戻り値

指定した構成セクション オブジェクト。指定したセクションが存在しない場合は nullThe specified configuration section object, or null if the section does not exist. GetSection(String, String) を実行時の操作として使用するには、セキュリティ上の制限があることに注意してください。Remember that security restrictions exist on the use of GetSection(String, String) as a run-time operation. たとえば、実行時に変更のためにセクションにアクセスできない場合があります。You might not be able to access a section at run time for modifications, for instance.

例外

メソッドが Web アプリケーション以外から呼び出されています。The method is called from outside a Web application.

有効な構成ファイルを読み込むことができませんでした。A valid configuration file could not be loaded.

次の例では、使用して構成情報にアクセスする方法を示しています、GetSectionメソッド。The following example shows how to access configuration information with the GetSection method.

注意

使用する方法を示します、GetSectionを取得するメソッド、ConfigurationSection指定した構成ファイルからのオブジェクト。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 'GetSection2


注釈

場合GetSectionが呼び出されますから、Web アプリケーション内でそのセクションを取得、構成階層の指定したパスで定義された構成ファイルから。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.

注意事項

アプリケーションは、HTTP 以外のプロトコルを使用する場合、GetSectionのパラメーター リストのセクションの名前とパスの両方を受け取るオーバー ロードは、1 つを使用します。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. システムが構成階層のレベルについてどのような想定できないために、構成ファイルのパスを指定する必要があります。You must specify the configuration file path because the system cannot make any assumptions about the configuration hierarchy level. 使用する場合、GetSectionのみセクション名、システムを取るオーバー ロードは常にしようとすると、アプリケーション レベルで構成設定を返します。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. ただし、こと、指定したパスが現在のアプリケーションの外部である場合は、パスを取るオーバー ロードを返すことも、現在実行中のアプリケーションのアプリケーション レベルの構成設定に注意してください。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.

このメソッドは、クライアント アプリケーション内からを呼び出すことはできません。This method cannot be called from within a client application.

現在のレベル、Web アプリケーション ディレクトリを使用してある構成ファイルから構成セクションを取得する場合、GetSectionメソッド。If you want to retrieve the configuration section from the configuration file located at the current Web application directory level, use the GetSection method.

注意

GetSectionメソッドは、アプリケーションを実行する階層レベルの構成ファイルのセクションで動作しているランタイム メソッドです。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. 操作では実行時以外を使用して、GetSection代わりにします。For a non-run-time operation, use GetSection instead. このメソッドによって、指定されたセクションのいずれかを使用して取得する構成ファイルの操作、openファイルの構成方法。This method operates on the specified section of a configuration file that you obtain using one of the open configuration file methods.

注意 (継承者)

戻り値は、使用する前に必要な構成型にキャストする必要があります。The return value must be cast to the expected configuration type before use. 可能性のあるキャスト例外を回避するには、条件付きのキャスト操作などを使用する必要があります、 as c# または 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.

こちらもご覧ください

適用対象