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	IDTSVirtualInput100のDTSObjectTypeを得ます。
SourceLocale	IDTSVirtualInput100の送信元のロケーションID(LCID)を取得します。
VirtualInputColumnCollection	IDTSVirtualInput100のIDTSVirtualInputColumnCollection100を得ます。

メソッド

名前	説明
SetUsageType(Int32, DTSUsageType)	仮想入力カラムオブジェクトをマッピングし、その使用タイプを設定します。