IDTSVirtualInput100 インターフェイス

定義

名前空間:

Microsoft.SqlServer.Dts.Pipeline.Wrapper

アセンブリ:

Microsoft.SqlServer.DTSPipelineWrap.dll

上流コンポーネントからコンポーネントが利用できる列を表します。

public interface class IDTSVirtualInput100 : Microsoft::SqlServer::Dts::Pipeline::Wrapper::IDTSObject100

[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)]
[System.Runtime.InteropServices.Guid("937BE9E1-F78D-4582-92EC-355CCF399702")]
public interface IDTSVirtualInput100 : Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSObject100

[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)>]
[<System.Runtime.InteropServices.Guid("937BE9E1-F78D-4582-92EC-355CCF399702")>]
type IDTSVirtualInput100 = interface
    interface IDTSObject100

Public Interface IDTSVirtualInput100
Implements IDTSObject100

属性

GuidAttribute TypeLibTypeAttribute

実装

IDTSObject100

例

次のコード例は、プログラムでデータ フロー タスクを作成するとき、仮想入力を使用してコンポーネントが使用する列を選択する方法を示しています。

public void SelectColumns(IDTSComponentMetaData100 md)  
{  
    // Create the design time instance of the component.  
    CManagedComponentWrapper wrp = md.Instantiate();  

    // Walk the input collection.  
    foreach (IDTSInput100 input in md.InputCollection)  
    {  
        // Get the virtual input columns.  
        IDTSVirtualInput100 vInput = input.GetVirtualInput();  

        // For each virtual column, set its usagetype to READONLY.  
        foreach (IDTSVirtualInputColumn100 vCol in vInput.VirtualInputColumnCollection)  
            wrp.SetUsageType(input.ID, vInput, vCol.LineageID, DTSUsageType.UT_READONLY);  
    }  
}  

Public Sub SelectColumns(ByVal md As IDTSComponentMetaData100)   
 Dim wrp As CManagedComponentWrapper = md.Instantiate   
 For Each input As IDTSInput100 In md.InputCollection   
   Dim vInput As IDTSVirtualInput100 = input.GetVirtualInput   
   For Each vCol As IDTSVirtualInputColumn100 In vInput.VirtualInputColumnCollection   
     wrp.SetUsageType(input.ID, vInput, vCol.LineageID, DTSUsageType.UT_READONLY)   
   Next   
 Next   
End Sub  

次のコード例は、入力がパスに接続されると、仮想入力からすべての DT_STR 列を選択するカスタム データ フロー コンポーネントを示しています。

public override void OnInputPathAttached(int inputID)  
{  
    IDTSInput100 input = ComponentMetaData.InputCollection.GetObjectByID(inputID);  
    IDTSVirtualInput100 vInput = input.GetVirtualInput();  

    foreach (IDTSVirtualInputColumn100 vCol in vInput.VirtualInputColumnCollection)  
    {  
        if (vCol.DataType == DataType.DT_STR)  
        {  
            this.SetUsageType(inputID, vInput, vCol.LineageID, DTSUsageType.UT_READONLY);  
        }  
    }  
}  

Public Overrides Sub OnInputPathAttached(ByVal inputID As Integer)   
 Dim input As IDTSInput100 = ComponentMetaData.InputCollection.GetObjectByID(inputID)   
 Dim vInput As IDTSVirtualInput100 = input.GetVirtualInput   
 For Each vCol As IDTSVirtualInputColumn100 In vInput.VirtualInputColumnCollection   
   If vCol.DataType = DataType.DT_STR Then   
     Me.SetUsageType(inputID, vInput, vCol.LineageID, DTSUsageType.UT_READONLY)   
   End If   
 Next   
End Sub  

注釈

IDTSVirtualInput100 を取得するには、GetVirtualInput オブジェクトの IDTSInput100 メソッドを呼び出します。 VirtualInputColumnCollection プロパティには、グラフの上流コンポーネントから利用できる列が含まれます。

データ フロー タスクをプログラムによって作成している場合は、SetUsageType の CManagedComponentWrapperClass メソッドを呼び出すことによってコンポーネントの仮想列が選択されます。

カスタム データ フロー コンポーネントを作成している開発者は、仮想入力を使用して利用可能な上流列を検出し、コンポーネントによっては、仮想コレクションの列に基づいて入力に列を追加します。

仮想入力には上流列が反映されるため、仮想入力または仮想入力コレクションの列を変更しても、IDTSOutput100 自体に影響はありません。

プロパティ

Description	IDTSVirtualInput100 オブジェクトの説明を取得または設定します。
ID	仮想入力オブジェクトの ID を取得します。値の設定も可能です。
IdentificationString	IDTSVirtualInput100 を一意に識別する文字列を取得します。
IsSorted	IDTSVirtualInput100 の仮想入力列を並べ替えるかどうかを指定する値を取得します。
Name	IDTSVirtualInput100 の名前を取得します。値の設定も可能です。
ObjectType	DTSObjectType の IDTSVirtualInput100 を取得します。
SourceLocale	IDTSVirtualInput100 のソースのロケール ID (LCID) を取得します。
VirtualInputColumnCollection	IDTSVirtualInputColumnCollection100 の IDTSVirtualInput100 を取得します。

メソッド

SetUsageType(Int32, DTSUsageType)

仮想入力列オブジェクトをマップし、使用法の種類を設定します。