ConfigurationManager.GetSection(String) メソッド
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
現在のアプリケーションの既定構成の、指定した構成セクションを取得します。
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
構成セクションのパスと名前。 ノード名は、"system.net/mailSettings/smtp" のように、スラッシュで区切られます。
戻り値
指定した ConfigurationSection オブジェクト。セクションが存在しない場合は null
。
例外
構成ファイルを読み込めませんでした。
例
GetSection メソッドを使用する方法の例を次に示します。 この例は、 クラスに対して提供される大きな例の ConfigurationManager 一部です。
// Create the AppSettings section.
// The function uses the GetSection(string)method
// to access the configuration section.
// It also adds a new element to the section collection.
public static void CreateAppSettings()
{
// Get the application configuration file.
System.Configuration.Configuration config =
ConfigurationManager.OpenExeConfiguration(
ConfigurationUserLevel.None);
string sectionName = "appSettings";
// Add an entry to appSettings.
int appStgCnt =
ConfigurationManager.AppSettings.Count;
string newKey = "NewKey" + appStgCnt.ToString();
string newValue = DateTime.Now.ToLongDateString() +
" " + DateTime.Now.ToLongTimeString();
config.AppSettings.Settings.Add(newKey, newValue);
// Save the configuration file.
config.Save(ConfigurationSaveMode.Modified);
// Force a reload of the changed section. This
// makes the new values available for reading.
ConfigurationManager.RefreshSection(sectionName);
// Get the AppSettings section.
AppSettingsSection appSettingSection =
(AppSettingsSection)config.GetSection(sectionName);
Console.WriteLine();
Console.WriteLine("Using GetSection(string).");
Console.WriteLine("AppSettings section:");
Console.WriteLine(
appSettingSection.SectionInformation.GetRawXml());
}
' Create the AppSettings section.
' The function uses the GetSection(string)method
' to access the configuration section.
' It also adds a new element to the section collection.
Public Shared Sub CreateAppSettings()
' Get the application configuration file.
Dim config As System.Configuration.Configuration = _
ConfigurationManager.OpenExeConfiguration( _
ConfigurationUserLevel.None)
Dim sectionName As String = "appSettings"
' Add an entry to appSettings.
Dim appStgCnt As Integer = _
ConfigurationManager.AppSettings.Count
Dim newKey As String = _
"NewKey" + appStgCnt.ToString()
Dim newValue As String = _
DateTime.Now.ToLongDateString() + " " + _
DateTime.Now.ToLongTimeString()
config.AppSettings.Settings.Add(newKey, _
newValue)
' Save the configuration file.
config.Save(ConfigurationSaveMode.Modified)
' Force a reload of the changed section. This
' makes the new values available for reading.
ConfigurationManager.RefreshSection(sectionName)
' Get the AppSettings section.
Dim appSettingSection As AppSettingsSection = _
DirectCast(config.GetSection(sectionName), _
AppSettingsSection)
Console.WriteLine()
Console.WriteLine( _
"Using GetSection(string).")
Console.WriteLine( _
"AppSettings section:")
Console.WriteLine( _
appSettingSection.SectionInformation.GetRawXml())
End Sub
注釈
クライアント アプリケーションの場合、このメソッドは、アプリケーション構成ファイル、ローカル ユーザー構成ファイル、およびローミング構成ファイルをマージして取得した構成ファイルを取得します。
メソッドは GetSection 、変更できない実行時の構成情報にアクセスします。 構成を変更するには、次のいずれかの方法を GetSection 使用して取得した構成ファイルで メソッドを使用します。
注意 (継承者)
戻り値を予想される構成の種類にキャストする必要があります。 キャスト例外の可能性を回避するには、C# の 演算子や Visual Basic の TryCast 関数などのas
条件付きキャスト操作を使用する必要があります。
適用対象
こちらもご覧ください
.NET