Variable クラス

パッケージ、タスク、またはコンテナーの変数を表します。 このクラスは継承できません。

継承階層

System.Object
  Microsoft.SqlServer.Dts.Runtime.DtsObject
    Microsoft.SqlServer.Dts.Runtime.Variable

名前空間:  Microsoft.SqlServer.Dts.Runtime
アセンブリ:  Microsoft.SqlServer.ManagedDTS (Microsoft.SqlServer.ManagedDTS.dll)

構文

'宣言
Public NotInheritable Class Variable _
    Inherits DtsObject _
    Implements IDTSPersist, IDTSName, IDTSPropertiesProvider, IDTSPackagePath,  _
    IDTSExecutionPath, IComponent, IDisposable
'使用
Dim instance As Variable

public sealed class Variable : DtsObject, 
    IDTSPersist, IDTSName, IDTSPropertiesProvider, IDTSPackagePath, IDTSExecutionPath, 
    IComponent, IDisposable

public ref class Variable sealed : public DtsObject, 
    IDTSPersist, IDTSName, IDTSPropertiesProvider, IDTSPackagePath, IDTSExecutionPath, 
    IComponent, IDisposable

[<SealedAttribute>]
type Variable =  
    class 
        inherit DtsObject 
        interface IDTSPersist 
        interface IDTSName 
        interface IDTSPropertiesProvider 
        interface IDTSPackagePath 
        interface IDTSExecutionPath 
        interface IComponent 
        interface IDisposable 
    end

public final class Variable extends DtsObject implements IDTSPersist, IDTSName, IDTSPropertiesProvider, IDTSPackagePath, IDTSExecutionPath, IComponent, IDisposable

Variable 型は、以下のメンバーを公開しています。

プロパティ

	名前	説明
	CreationName	ランタイム エンジンが Variable オブジェクトのインスタンスを作成し、このオブジェクトを Variables コレクションに追加する場合に、このランタイム エンジンによって指定される文字列を取得します。このプロパティは読み取り専用です。
	DataType	変数のデータ型を示す TypeCode 列挙を取得します。このプロパティは読み取り専用です。
	Description	変数の説明を取得します。値の設定も可能です。
	EvaluateAsExpression	変数に式が含まれているかどうかを示す Boolean を取得します。値の設定も可能です。
	Expression	変数に含まれる式を取得します。値の設定も可能です。
	ID	変数に割り当てられた GUID を取得します。このフィールドは読み取り専用です。
	IncludeInDebugDump	ユーザー定義変数またはシステム変数の変数値がデバッグ ダンプ ファイルに含まれるかどうかを示す値を取得します。値の設定も可能です。
	Name	変数の名前を取得します。値の設定も可能です。
	Namespace	変数が属する名前空間を取得します。値の設定も可能です。
	Parent	Variable インスタンスの親コンテナーを取得します。
	Properties	DtsProperty オブジェクトのコレクションを取得します。このプロパティは読み取り専用です。
	QualifiedName	名前空間を含む、変数の完全修飾名を取得します。このプロパティは読み取り専用です。
	RaiseChangedEvent	変数の値が変更される場合に、OnVariableValueChanged イベントを発生させるように変数のフラグが設定されたかどうかを示す Boolean を取得または設定します。
	ReadOnly	変数が読み取り専用であり、値を変更できないことを示す Boolean を取得します。値の設定も可能です。
	Site	インフラストラクチャです。変数のサイトを取得または設定します。
	SystemVariable	変数がシステム変数であるかどうかを示す Boolean を取得します。このプロパティは読み取り専用です。
	Value	変数に割り当てられた値を取得します。値の設定も可能です。

先頭に戻る

メソッド

	名前	説明
	Dispose	このメソッドは、オブジェクトにクリーンアップを実行するように明示的に通知するメカニズムである IDisposable.Dispose メソッドから継承されます。
	Equals	2 つのオブジェクト インスタンスが等しいかどうかを示します。 (DtsObject から継承されています。)
	GetExecutionPath	現在の Variable オブジェクトの実行パスを返します。
	GetExpression	GetExpression メソッドは、Variable オブジェクトではサポートされません。代わりに EvaluateAsExpression プロパティを使用します。
	GetHashCode	このインスタンスのハッシュ コードを返します。 (DtsObject から継承されています。)
	GetPackagePath	変数が属するパッケージのパスを返します。
	GetSensitiveValue	機微な変数値を返します。
	GetType	(Object から継承されています。)
	LoadFromXML	このメソッドをアプリケーション コードから呼び出すことはできません。.xml として保存されたパッケージを読み込むには、Application.LoadPackage メソッドを使用します。
	SaveToXML	このメソッドをアプリケーション コードから呼び出すことはできません。パッケージを .xml として保存するには、Application.SaveToXml メソッドを使用します。
	SetExpression	SetExpression メソッドは、Variable オブジェクトではサポートされません。代わりに EvaluateAsExpression プロパティを使用します。
	ToString	(Object から継承されています。)

先頭に戻る

イベント

	名前	説明
	Disposed	イベント ハンドラーを追加して、変数の Disposed イベントを待機します。

先頭に戻る

説明

変数は、あいまいさを排除するために、名前空間にグループ化されます。 System 名前空間は、各パッケージに対して自動的に作成され、読み取り専用プロパティを含みます。 User 名前空間は、追加できるカスタム プロパティを含みます。 変数の追加先となる選択対象の名前空間も作成できます。 このクラスは、Visual Studio .NET Framework の次の 2 つの例を含む複数のクラスおよびインターフェイスから継承します。

• IComponent

• IDisposable

スレッド セーフ

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

関連項目

参照

Microsoft.SqlServer.Dts.Runtime 名前空間