ScriptComponent クラス
スクリプト コンポーネント プロジェクトの ComponentWrapper プロジェクト項目内で、スクリプト コンポーネントによって生成される読み取り専用の UserComponent クラスの基本クラスとして機能します。
継承階層
System. . :: . .Object
Microsoft.SqlServer.Dts.Pipeline..::..ScriptComponent
名前空間: Microsoft.SqlServer.Dts.Pipeline
アセンブリ: Microsoft.SqlServer.TxScript (Microsoft.SqlServer.TxScript.dll)
構文
'宣言
Public Class ScriptComponent
'使用
Dim instance As ScriptComponent
public class ScriptComponent
public ref class ScriptComponent
type ScriptComponent = class end
public class ScriptComponent
ScriptComponent 型は、以下のメンバーを公開しています。
プロパティ
名前 | 説明 | |
---|---|---|
ComponentMetaData | コンポーネント定義への参照を返します。 | |
ReadOnlyVariables | コンポーネントが利用可能な ReadOnlyVariables のコレクションを返します。 | |
ReadWriteVariables | コンポーネントが利用可能な ReadWriteVariables のコレクションを返します。 | |
VariableDispenser | データ フローが変数を使用するために内部的に使用するオブジェクトを返します。 |
先頭に戻る
メソッド
名前 | 説明 | |
---|---|---|
AcquireConnections | 接続マネージャを使用することにより、接続または接続情報を取得します。 | |
Equals | (Object から継承されています。) | |
Finalize | (Object から継承されています。) | |
GetColumnIndexes | インフラストラクチャです。 | |
GetHashCode | (Object から継承されています。) | |
GetType | (Object から継承されています。) | |
Log | ログ エントリを書き込みます。 | |
MemberwiseClone | (Object から継承されています。) | |
PostExecute | スクリプト コンポーネントが入力および出力を処理した後に実行する必要があるカスタム コードを実行します。 | |
PreExecute | スクリプト コンポーネントが入力および出力を処理する前に実行する必要があるカスタム コードを実行します。 | |
PrimeOutput | 出力バッファに新しい行を追加する、非同期出力型の変換元や変換などのスクリプト コンポーネントの出力を準備します。 | |
ProcessInput | 上流コンポーネントから入力を受信する、変換や変換先などのスクリプト コンポーネントの入力を処理します。 | |
ReleaseConnections | 接続マネージャへの接続を解放します。 | |
SetBufferColumnIndexes | インフラストラクチャです。 | |
ToString | (Object から継承されています。) |
先頭に戻る
説明
ScriptComponent クラスは、スクリプト コンポーネント プロジェクトの ComponentWrapper プロジェクト項目内で、スクリプト コンポーネントによって生成される読み取り専用の UserComponent クラスの基本クラスとして機能します。UserComponent クラスは、開発者がカスタム コードを記述する ScriptMain クラスの基本クラスとして機能し、コンポーネントの入力および出力を処理する一連のメソッドを開発者に提供します。また、コンポーネントで使用できる変数および接続マネージャに、厳密に型指定されたアクセサ プロパティを提供します。
スクリプト コンポーネント開発者は、直接的には ScriptComponent クラスを使用しませんが、UserComponent クラスを介して ScriptComponent から継承する ScriptMain クラスのメソッドおよびプロパティをコーディングすることにより、間接的に使用します。
詳細については、「スクリプト コンポーネントのコーディングおよびデバッグ」および「スクリプト コンポーネントのオブジェクト モデルについて」を参照してください。
使用例
次のコード サンプルに、開発者がスクリプト コンポーネントを使用して同期出力型の変換を作成するときに記述する必要があるすべてのコードを示します。このサンプルの詳細については、「スクリプト コンポーネントによる同期変換の作成」を参照してください。
Public Class ScriptMain
Inherits UserComponent
Public Overrides Sub MyAddressInput_ProcessInputRow(ByVal Row As MyAddressInputBuffer)
Row.City = UCase(Row.City)
End Sub
End Class
スレッド セーフ
この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。