Variable クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
パッケージ、タスク、またはコンテナーの変数を表します。 このクラスは継承できません。
public ref class Variable sealed : Microsoft::SqlServer::Dts::Runtime::DtsObject, IDisposable, Microsoft::SqlServer::Dts::Runtime::IDTSExecutionPath, Microsoft::SqlServer::Dts::Runtime::IDTSName, Microsoft::SqlServer::Dts::Runtime::IDTSPackagePath, Microsoft::SqlServer::Dts::Runtime::IDTSPersist, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProvider, System::ComponentModel::IComponent
public sealed class Variable : Microsoft.SqlServer.Dts.Runtime.DtsObject, IDisposable, Microsoft.SqlServer.Dts.Runtime.IDTSExecutionPath, Microsoft.SqlServer.Dts.Runtime.IDTSName, Microsoft.SqlServer.Dts.Runtime.IDTSPackagePath, Microsoft.SqlServer.Dts.Runtime.IDTSPersist, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProvider, System.ComponentModel.IComponent
type Variable = class
inherit DtsObject
interface IDTSPersist
interface IDTSName
interface IDTSPropertiesProvider
interface IDTSPackagePath
interface IDTSExecutionPath
interface IComponent
interface IDisposable
Public NotInheritable Class Variable
Inherits DtsObject
Implements IComponent, IDisposable, IDTSExecutionPath, IDTSName, IDTSPackagePath, IDTSPersist, IDTSPropertiesProvider
- 継承
- 実装
注釈
変数は、あいまいさを排除するために、名前空間にグループ化されます。 System
名前空間は、各パッケージに対して自動的に作成され、読み取り専用プロパティを含みます。 User
名前空間は、追加できるカスタム プロパティを含みます。 変数の追加先となる選択対象の名前空間も作成できます。 このクラスは、Visual Studio .NET Framework の次の 2 つの例を含む複数のクラスおよびインターフェイスから継承します。
プロパティ
CreationName |
ランタイム エンジンが Variable オブジェクトのインスタンスを作成し、このオブジェクトを Variables コレクションに追加する場合に、このランタイム エンジンによって指定される文字列を取得します。 このプロパティは読み取り専用です。 |
DataType |
変数のデータ型を示す TypeCode 列挙を取得します。 このプロパティは読み取り専用です。 |
Description |
変数の説明を取得します。値の設定も可能です。 |
EvaluateAsExpression |
変数に式が含まれているかどうかを示すブール型 (Boolean) の値を取得または設定します。 |
Expression |
変数に含まれる式を取得します。値の設定も可能です。 |
ID |
変数に割り当てられた GUID を取得します。 このフィールドは読み取り専用です。 |
IncludeInDebugDump |
ユーザー定義変数またはシステム変数の変数値がデバッグ ダンプ ファイルに含まれるかどうかを示す値を取得します。値の設定も可能です。 |
Name |
変数の名前を取得します。値の設定も可能です。 |
Namespace |
変数が属する名前空間を取得します。値の設定も可能です。 |
Parent |
Variable インスタンスの親コンテナーを取得します。 |
Properties |
DtsProperty オブジェクトのコレクションを取得します。 このプロパティは読み取り専用です。 |
QualifiedName |
名前空間を含む、変数の完全修飾名を取得します。 このプロパティは読み取り専用です。 |
RaiseChangedEvent |
変数の値が変更されたときにイベントを発生 OnVariableValueChanged(DtsContainer, Variable, Boolean) させるフラグが変数に設定されているかどうかを示すブール型 (Boolean) の値を取得または設定します。 |
ReadOnly |
変数が読み取り専用であり、値を変更できないことを示すブール型 (Boolean) の値を取得または設定します。 |
Site |
変数のサイトを取得または設定します。 |
SystemVariable |
変数がシステム変数かどうかを示すブール値を取得します。 このプロパティは読み取り専用です。 |
Value |
変数に割り当てられた値を取得します。値の設定も可能です。 |
メソッド
Dispose() |
このメソッドは、オブジェクトにクリーンアップを実行するように明示的に通知するメカニズムである IDisposable.Dispose メソッドから継承されます。 |
Equals(Object) |
2 つのオブジェクト インスタンスが等しいかどうかを判断します。 (継承元 DtsObject) |
GetExecutionPath() |
現在の Variable オブジェクトの実行パスを返します。 |
GetExpression(String) |
GetExpression(String) メソッドは、Variable オブジェクトではサポートされません。 代わりに、EvaluateAsExpression プロパティを使用してください。 |
GetHashCode() |
このインスタンスのハッシュ コードを返します。 (継承元 DtsObject) |
GetPackagePath() |
変数が属するパッケージのパスを返します。 |
GetSensitiveValue() |
機微な変数値を返します。 |
LoadFromXML(XmlNode, IDTSEvents) |
このメソッドをアプリケーション コードから呼び出すことはできません。 .xml として保存されたパッケージを読み込むには、LoadPackage(String, IDTSEvents) メソッドを使用します。 |
SaveToXML(XmlDocument, XmlNode, IDTSEvents) |
このメソッドをアプリケーション コードから呼び出すことはできません。 パッケージを .xml として保存するには、SaveToXml(String, Package, IDTSEvents) メソッドを使用します。 |
SetExpression(String, String) |
SetExpression(String, String) メソッドは、Variable オブジェクトではサポートされません。 代わりに、EvaluateAsExpression プロパティを使用してください。 |
イベント
Disposed |
イベント ハンドラーを追加して、変数の Disposed イベントを待機します。 |