Configurationとは何？わかりやすく解説 Weblio辞書

すべての辞書から再検索する

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

Configuration クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

特定のコンピュータ、アプリケーション、またはリソースに適用できる構成ファイルを表します。このクラスは継承できません。

名前空間: System.Configuration
アセンブリ: System.Configuration (system.configuration.dll 内)
構文

Visual Basic (宣言)

Public NotInheritable Class
 Configuration

Visual Basic (使用法)

Dim instance As Configuration

public sealed class Configuration

C++

public ref class Configuration sealed

public final class Configuration

JScript

public final class Configuration

解説

Configuration クラスインスタンスは、特定の物理エンティティ (コンピュータなど) または論理エンティティ (アプリケーションや Web サイトなど) に適用される構成設定のマージされたビューを表します。指定された論理エンティティは、ローカルコンピュータまたはリモートサーバーに存在することがあります。

指定したエンティティ用の構成ファイルが存在しない場合、Configuration オブジェクトは、Machine.config ファイルで定義されている既定の構成設定を表します。

次のクラスで定義されている、構成のオープンメソッドの 1 つを使用して、Configuration オブジェクトを取得できます。

指定したエンティティ用の継承された構成設定を表す構成ファイルを生成するには、構成の保存メソッドの 1 つを使用します。

メモ
リモートコンピュータ上の構成設定にアクセスできるようにするには、Aspnet_regiis コマンドラインツールを使用します。このツールの詳細については、「ASP.NET IIS 登録ツール (Aspnet_regiis.exe)」を参照してください。.NET Framework に含まれている組み込みセクション以外のカスタム構成設定の作成およびアクセスの詳細については、ConfigurationSection のトピックを参照してください。

メモ

リモートコンピュータ上の構成設定にアクセスできるようにするには、Aspnet_regiis コマンドラインツールを使用します。このツールの詳細については、「ASP.NET IIS 登録ツール (Aspnet_regiis.exe)」を参照してください。.NET Framework に含まれている組み込みセクション以外のカスタム構成設定の作成およびアクセスの詳細については、ConfigurationSection のトピックを参照してください。

実装時の注意 Configuration は、構成ファイルの編集をプログラムから行うことができるようにするクラスです。Web アプリケーション用の WebConfigurationManager またはクライアントアプリケーション用の ConfigurationManager に用意されているオープンメソッドの 1 つを使用します。これらのメソッドは、Configuration オブジェクトを返します。このオブジェクトにより、基になる構成ファイルを処理するために必要なメソッドとプロパティが提供されます。次に示す方法で、これらのファイルへの読み取りアクセスまたは書き込みアクセスができます。

読み取り。構成情報を読み取るには、GetSection または GetSectionGroup を使用します。読み取りを行うユーザーまたはプロセスに、次のアクセス許可が必要です。
- 現在の構成階層レベルの構成ファイルに対する読み取りアクセス許可。
- すべての親構成ファイルに対する読み取りアクセス許可。

アプリケーションが独自の構成に対する読み取り専用アクセスを行う必要がある場合は、GetSection のオーバーロードメソッドを使用することをお勧めします (Web アプリケーションの場合)。クライアントアプリケーションの場合は、GetSection メソッドを使用します。これらのメソッドにより、現在のアプリケーションのキャッシュされた構成値にアクセスできます。こちらの方が、Configuration クラスよりもパフォーマンスが優れています。

メモ
パスパラメータを受け取る静的な GetSection メソッドを使用する場合、パスパラメータは、コードを実行しているアプリケーションを参照している必要があります。そうでない場合は、パラメータが無視され、現在実行中のアプリケーションの構成情報が返されます。

書き込み。構成情報を書き込むには、Save メソッドの 1 つを使用します。書き込みを行うユーザーまたはプロセスに、次のアクセス許可が必要です。
- 現在の構成階層レベルの構成ファイルおよびディレクトリに対する書き込みアクセス許可。
- すべての構成ファイルに対する読み取りアクセス許可。

Topic	Location
方法 : SqlDataSource コントロールを使用して Oracle データベースに接続する	ASP .NET Web アプリケーションの作成

使用例

Configuration クラスを使用して、カスタムセクションが含まれている構成ファイルを作成する方法を次のコード例に示します。

Visual Basic

' Create a custom section.
Shared Sub CreateSection() 
    Try
        
        Dim customSection As CustomSection
        
        ' Get the current configuration file.
        Dim config As _
        System.Configuration.Configuration = _
        ConfigurationManager.OpenExeConfiguration( _
        ConfigurationUserLevel.None)
        
        ' Create the section entry  
        ' in <configSections> and the 
        ' related target section in <configuration>.
        If config.Sections("CustomSection")
 Is Nothing Then
            customSection = New CustomSection()
            config.Sections.Add("CustomSection", customSection)
            customSection.SectionInformation.ForceSave = True
            config.Save(ConfigurationSaveMode.Full)
            
            Console.WriteLine( _
            "Section name: {0} created", _
            customSection.SectionInformation.Name)
        End If
    
    Catch err As ConfigurationErrorsException
        Console.WriteLine(err.ToString())
    End Try

End Sub 'CreateSection

       
// Create a custom section.
static void CreateSection()
{
    try
    {

        CustomSection customSection;

        // Get the current configuration file.
        System.Configuration.Configuration config =
                ConfigurationManager.OpenExeConfiguration(
                ConfigurationUserLevel.None);

        // Create the section entry  
        // in <configSections> and the 
        // related target section in <configuration>.
        if (config.Sections["CustomSection"] == null)
        {
            customSection = new CustomSection();
            config.Sections.Add("CustomSection", customSection);
            customSection.SectionInformation.ForceSave = true;
            config.Save(ConfigurationSaveMode.Full);

            Console.WriteLine("Section name: {0} created",
                customSection.SectionInformation.Name);

        }
    }
    catch (ConfigurationErrorsException err)
    {
        Console.WriteLine(err.ToString());
    }

}

前述の例で使用されているカスタムセクションの定義を次に示します。

Visual Basic

' Define a custom section.

NotInheritable Public Class
 CustomSection
    Inherits ConfigurationSection
    
    
    Public Enum Permissions
        FullControl = 0
        Modify = 1
        ReadExecute = 2
        Read = 3
        Write = 4
        SpecialPermissions = 5
    End Enum 'Permissions
    
    
    Public Sub New() 
    
    End Sub 'New
    
    
    
    <ConfigurationProperty("fileName", _
    DefaultValue:="default.txt"), _
    StringValidator(InvalidCharacters:=" ~!@#$%^&*()[]{}/;'""|\",
 _
    MinLength:=1, MaxLength:=60)> _
    Public Property FileName() As
 String
        Get
            Return CStr(Me("fileName"))
        End Get
        Set(ByVal value As
 String)
            Me("fileName") = Value
        End Set
    End Property
    
    
    <ConfigurationProperty("maxIdleTime", _
    DefaultValue:="1:30:30")> _
    Public Property MaxIdleTime() As
 TimeSpan
        Get
            Return CType(Me("maxIdleTime"),
 TimeSpan)
        End Get
        Set(ByVal value As
 TimeSpan)
            Me("maxIdleTime") =
 Value
        End Set
    End Property
    
    
    
    <ConfigurationProperty("permission", _
    DefaultValue:=Permissions.Read)> _
    Public Property Permission() As
 Permissions
        Get
            Return CType(Me("permission"),
 Permissions)
        End Get

        Set(ByVal value As
 Permissions)
            Me("permission") =
 Value
        End Set
    End Property
End Class 'CustomSection

// Define a custom section.
public sealed class CustomSection :
    ConfigurationSection
{

    public enum Permissions
    {
        FullControl = 0,
        Modify = 1,
        ReadExecute = 2,
        Read = 3,
        Write = 4,
        SpecialPermissions = 5
    }

    public CustomSection()
    {

    }

    [ConfigurationProperty("fileName", 
        DefaultValue = "default.txt")]
    [StringValidator(InvalidCharacters = " ~!@#$%^&*()[]{}/;'\"|\\"
,
               MinLength = 1, MaxLength = 60)]
    public String FileName
    {
        get
        {
            return (String)this["fileName"];
        }
        set
        {
            this["fileName"] = value;
        }
    }
   
    [ConfigurationProperty("maxIdleTime", DefaultValue="1:30:30")]
    public TimeSpan MaxIdleTime
    {
        get
        {
            return (TimeSpan)this["maxIdleTime"];
        }
        set
        {
            this["maxIdleTime"] = value;
        }
    }
    

    [ConfigurationProperty("permission", 
        DefaultValue = Permissions.Read)]
    public Permissions Permission
    {
        get
        {
            return (Permissions)this["permission"];
        }

        set
        {
            this["permission"] = value;
        }

    }
  
}

前述の例で使用されている構成の抜粋を次に示します。

<?xml version="1.0" encoding="utf-8"?>

<configuration>

  <configSections>
    <section name="CustomSection" type="Samples.AspNet.CustomSection, 
      Configuration, Version=1.0.0.0, Culture=neutral, 
      PublicKeyToken=null" allowDefinition="Everywhere" 
      allowExeDefinition="MachineToApplication" 
      restartOnExternalChanges="true" />
  </configSections>
    <CustomSection fileName="default.txt" maxIdleTime="01:30:30"
      permission="Read" />

</configuration>

継承階層

System.Object
System.Configuration.Configuration

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。

プラットフォーム

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
Configuration メンバ
System.Configuration 名前空間
ConfigurationSection
その他の技術情報
ASP.NET アプリケーションの構成

Configuration プロパティ

パブリックプロパティパブリックプロパティ

	名前	説明
	AppSettings	この Configuration オブジェクトに適用される AppSettingsSection オブジェクトの構成セクションを取得します。
	ConnectionStrings	この Configuration オブジェクトに適用される ConnectionStringsSection 構成セクションオブジェクトを取得します。
	EvaluationContext	Configuration オブジェクトの ContextInformation オブジェクトを取得します。
	FilePath	この Configuration オブジェクトによって表される構成ファイルへの物理パスを取得します。
	HasFile	この Configuration オブジェクトによって表されるリソース用の構成ファイルがあるかどうかを示します。
	Locations	この Configuration オブジェクト内で定義されている位置を取得します。
	NamespaceDeclared	構成ファイルに XML 名前空間があるかどうかを示す値を取得または設定します。
	RootSectionGroup	この Configuration オブジェクトのルート ConfigurationSectionGroup を取得します。
	SectionGroups	この構成で定義されているセクショングループのコレクションを取得します。
	Sections	この構成で定義されているセクションのコレクションを取得します。

参照

その他の技術情報

ASP.NET アプリケーションの構成

Configuration メソッド

パブリックメソッドパブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetSection	指定した ConfigurationSection オブジェクトを返します。
	GetSectionGroup	指定した ConfigurationSectionGroup オブジェクトを取得します。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	Save	オーバーロードされます。この Configuration オブジェクトに格納されている構成設定を、現在の XML 構成ファイルに書き込みます。
	SaveAs	オーバーロードされます。この Configuration オブジェクトに格納されている構成設定を、指定された XML 構成ファイルに書き込みます。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

その他の技術情報

ASP.NET アプリケーションの構成

Configuration メンバ

特定のコンピュータ、アプリケーション、またはリソースに適用できる構成ファイルを表します。このクラスは継承できません。

Configuration データ型で公開されるメンバを以下の表に示します。

パブリックプロパティ

	名前	説明
	AppSettings	この Configuration オブジェクトに適用される AppSettingsSection オブジェクトの構成セクションを取得します。
	ConnectionStrings	この Configuration オブジェクトに適用される ConnectionStringsSection 構成セクションオブジェクトを取得します。
	EvaluationContext	Configuration オブジェクトの ContextInformation オブジェクトを取得します。
	FilePath	この Configuration オブジェクトによって表される構成ファイルへの物理パスを取得します。
	HasFile	この Configuration オブジェクトによって表されるリソース用の構成ファイルがあるかどうかを示します。
	Locations	この Configuration オブジェクト内で定義されている位置を取得します。
	NamespaceDeclared	構成ファイルに XML 名前空間があるかどうかを示す値を取得または設定します。
	RootSectionGroup	この Configuration オブジェクトのルート ConfigurationSectionGroup を取得します。
	SectionGroups	この構成で定義されているセクショングループのコレクションを取得します。
	Sections	この構成で定義されているセクションのコレクションを取得します。

パブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetSection	指定した ConfigurationSection オブジェクトを返します。
	GetSectionGroup	指定した ConfigurationSectionGroup オブジェクトを取得します。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	Save	オーバーロードされます。この Configuration オブジェクトに格納されている構成設定を、現在の XML 構成ファイルに書き込みます。
	SaveAs	オーバーロードされます。この Configuration オブジェクトに格納されている構成設定を、指定された XML 構成ファイルに書き込みます。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)