SourceSwitch

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

SourceSwitch クラス

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

コードを再コンパイルせずに、トレースやデバッグの出力を制御する複数レベルのスイッチを提供します。

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

Visual Basic (宣言)

Public Class SourceSwitch
    Inherits Switch

Visual Basic (使用法)

Dim instance As SourceSwitch

C#

public class SourceSwitch : Switch

C++

public ref class SourceSwitch : public
 Switch

J#

public class SourceSwitch extends Switch

JScript

public class SourceSwitch extends
 Switch

解説

TraceSource クラスの Switch プロパティは、SourceSwitch オブジェクトです。SourceSwitch クラスは、スイッチのイベント レベルをテストする Level プロパティを提供します。Level プロパティは、スイッチの TraceLevel 値を取得または設定します。

アプリケーション構成ファイルで SourceSwitch のイベント レベルを設定し、構成した SourceSwitch レベルをアプリケーションで使用できます。または、SourceSwitch をコード内に作成し、レベルを直接設定してコードの特定のセクションをインストルメントすることもできます。

SourceSwitch を構成するには、アプリケーションの名前に対応した構成ファイルを編集します。このファイルでは、スイッチの値の設定や、アプリケーションで以前設定されたすべてのスイッチのクリアを実行できます。構成ファイルの書式は次の例のようになります。

<switches>
  <add name="SourceSwitch" value="Verbose"></add>
</switches>

スイッチは、トレースを反映するか、または無視するかを確認するために使用されます。各 TraceSource トレース メソッドは、リスナを呼び出す前に ShouldTrace メソッドを呼び出します。ShouldTrace メソッドが false を返した場合、トレースは無視され、トレース メソッドは終了します。ShouldTrace メソッドが true を返した場合、トレースはリスナに渡されます。

Topic	Location
方法 : トレース スイッチを作成し初期化する	.NET Framework: デバッグ
方法 : トレース スイッチを設定する	.NET Framework: デバッグ

継承階層

System.Object
   System.Diagnostics.Switch
    System.Diagnostics.SourceSwitch

スレッド セーフ

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SourceSwitch メンバ
System.Diagnostics 名前空間

SourceSwitch コンストラクタ (String)

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

ソースの名前を指定して、SourceSwitch クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    name As String _
)

Visual Basic (使用法)

Dim name As String

Dim instance As New SourceSwitch(name)

C#

public SourceSwitch (
    string name
)

C++

public:
SourceSwitch (
    String^ name
)

J#

public SourceSwitch (
    String name
)

JScript

public function SourceSwitch (
    name : String
)

パラメータ

name

ソースの名前。

解説

name パラメータは、DisplayName プロパティの値を設定するために使用されます。

SourceSwitch のレベルを設定するには、アプリケーション名に対応する構成ファイルを編集します。このファイルでは、スイッチの追加、その値の設定、スイッチの削除、アプリケーションで以前設定されたすべてのスイッチのクリアを実行できます。ソース スイッチを追加する場合、構成ファイルを次の例のように書式設定する必要があります。

<configuration>
  <system.diagnostics>
    <switches>
      <add name="SourceSwitch" value="Verbose" ></add>
    </switches>
  </system.diagnostics>
</configuration>

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SourceSwitch クラス
SourceSwitch メンバ
System.Diagnostics 名前空間

SourceSwitch コンストラクタ

SourceSwitch クラスの新しいインスタンスを初期化します。
オーバーロードの一覧

名前	説明
SourceSwitch (String)	ソースの名前を指定して、SourceSwitch クラスの新しいインスタンスを初期化します。
SourceSwitch (String, String)	ソース スイッチの表示名および既定値を指定して、SourceSwitch クラスの新しいインスタンスを初期化します。

参照

関連項目

SourceSwitch クラス
SourceSwitch メンバ
System.Diagnostics 名前空間

SourceSwitch コンストラクタ (String, String)

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

ソース スイッチの表示名および既定値を指定して、SourceSwitch クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    displayName As String, _
    defaultSwitchValue As String _
)

Visual Basic (使用法)

Dim displayName As String
Dim defaultSwitchValue As String

Dim instance As New SourceSwitch(displayName,
 defaultSwitchValue)

C#

public SourceSwitch (
    string displayName,
    string defaultSwitchValue
)

C++

public:
SourceSwitch (
    String^ displayName, 
    String^ defaultSwitchValue
)

J#

public SourceSwitch (
    String displayName, 
    String defaultSwitchValue
)

JScript

public function SourceSwitch (
    displayName : String, 
    defaultSwitchValue : String
)

パラメータ

displayName

ソース スイッチの名前。

defaultSwitchValue

スイッチの既定値。

解説

displayName パラメータは、DisplayName プロパティの値を設定するために使用されます。defaultSwitchValue パラメータはフィールドとして保存され、最初の参照で Value プロパティを初期化するために使用されます。

メモ
スイッチが構成ファイルで定義されていて、value 属性が指定されている場合は、構成ファイル値が優先され、defaultSwitchValue は無視されます。

SourceSwitch のレベルを設定するには、アプリケーション名に対応する構成ファイルを編集します。このファイルでは、スイッチの追加、その値の設定、スイッチの削除、アプリケーションで以前設定されたすべてのスイッチのクリアを実行できます。ソース スイッチを追加する場合、構成ファイルを次の例のように書式設定する必要があります。

<configuration>
  <system.diagnostics>
    <switches>
      <add name="SourceSwitch" value="Verbose" ></add>
    </switches>
  </system.diagnostics>
</configuration>

使用例

"SourceSwitch" という名前で、Verbose の既定値を使用して、SourceSwitch を作成するコード例を次に示します。このコード例は、TraceSource クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

#If (ConfigFile = False) Then
            Dim sourceSwitch As New
 SourceSwitch("SourceSwitch", "Verbose")
#End If

C#

#if(!ConfigFile)
                SourceSwitch sourceSwitch = new SourceSwitch("SourceSwitch",
 "Verbose");
#endif

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SourceSwitch クラス
SourceSwitch メンバ
System.Diagnostics 名前空間

SourceSwitch プロパティ

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	Attributes	アプリケーション構成ファイルに定義されているカスタム スイッチ属性を取得します。 ( Switch から継承されます。)
	Description	スイッチの説明を取得します。 ( Switch から継承されます。)
	DisplayName	スイッチを識別するための名前を取得します。 ( Switch から継承されます。)
	Level	スイッチのレベルを取得または設定します。

プロテクト プロパティ

	名前	説明
	SwitchSetting	このスイッチの現在の設定を取得または設定します。 ( Switch から継承されます。)
	Value	スイッチの値を取得または設定します。 ( Switch から継承されます。)

参照

関連項目

SourceSwitch クラス
System.Diagnostics 名前空間

SourceSwitch メソッド

パブリック メソッド

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

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ShouldTrace	トレース イベントの種類に基づいて、トレース リスナを呼び出すかどうかを決定します。
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	GetSupportedAttributes	スイッチによってサポートされるカスタム属性を取得します。 ( Switch から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)
	OnSwitchSettingChanged	SwitchSetting プロパティが変更されると発生します。 ( Switch から継承されます。)
	OnValueChanged	オーバーライドされます。 Value プロパティが変更された場合に発生します。

参照

関連項目

SourceSwitch クラス
System.Diagnostics 名前空間

SourceSwitch メンバ

コードを再コンパイルせずに、トレースやデバッグの出力を制御する複数レベルのスイッチを提供します。

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

パブリック コンストラクタ

	名前	説明
	SourceSwitch	オーバーロードされます。 SourceSwitch クラスの新しいインスタンスを初期化します。

パブリック プロパティ

( プロテクト プロパティ も参照)

	名前	説明
	Attributes	アプリケーション構成ファイルに定義されているカスタム スイッチ属性を取得します。(Switch から継承されます。)
	Description	スイッチの説明を取得します。(Switch から継承されます。)
	DisplayName	スイッチを識別するための名前を取得します。(Switch から継承されます。)
	Level	スイッチのレベルを取得または設定します。

プロテクト プロパティ

	名前	説明
	SwitchSetting	このスイッチの現在の設定を取得または設定します。(Switch から継承されます。)
	Value	スイッチの値を取得または設定します。(Switch から継承されます。)

パブリック メソッド

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

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ShouldTrace	トレース イベントの種類に基づいて、トレース リスナを呼び出すかどうかを決定します。
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	GetSupportedAttributes	スイッチによってサポートされるカスタム属性を取得します。 (Switch から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)
	OnSwitchSettingChanged	SwitchSetting プロパティが変更されると発生します。 (Switch から継承されます。)
	OnValueChanged	オーバーライドされます。 Value プロパティが変更された場合に発生します。

参照

関連項目

SourceSwitch クラス
System.Diagnostics 名前空間