IDTSVirtualInput100 Interface

Définition

Espace de noms:

Microsoft.SqlServer.Dts.Pipeline.Wrapper

Assembly:

Microsoft.SqlServer.DTSPipelineWrap.dll

Représente les colonnes disponibles pour un composant à partir du composant en amont.

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

Attributs

GuidAttribute TypeLibTypeAttribute

Implémente

IDTSObject100

Exemples

L’exemple de code suivant montre comment utiliser l’entrée virtuelle pour sélectionner les colonnes utilisées par un composant lors de la création par programme de la tâche de flux de données.

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  

L’exemple de code suivant montre un composant de flux de données personnalisé qui sélectionne toutes les colonnes DT_STR à partir de l’entrée virtuelle lorsque l’entrée est connectée à un chemin d’accès.

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  

Remarques

L’objet IDTSVirtualInput100 est récupéré en appelant la GetVirtualInput méthode d’un IDTSInput100 objet. La VirtualInputColumnCollection propriété contient les colonnes disponibles à partir des composants en amont du graphique.

Lors de la génération par programmation d’une tâche de flux de données, les colonnes virtuelles sont sélectionnées pour un composant en appelant la SetUsageType méthode du CManagedComponentWrapperClass.

Les développeurs écrivant des composants de flux de données personnalisés utilisent l’entrée virtuelle pour découvrir les colonnes en amont disponibles et, selon le composant, pour ajouter des colonnes à l’entrée en fonction des colonnes de la collection virtuelle.

Étant donné que l’entrée virtuelle est une réflexion sur les colonnes en amont, les modifications apportées à l’entrée virtuelle ou aux colonnes de la collection d’entrées virtuelles n’ont aucun impact sur le IDTSOutput100 lui-même.

Propriétés

Description	Obtient ou définit la description d'un objet IDTSVirtualInput100.
ID	Obtient ou définit l'ID d'un objet d'entrée virtuel.
IdentificationString	Obtient une chaîne qui identifie de manière unique l'objet IDTSVirtualInput100.
IsSorted	Obtient une valeur qui indique si les colonnes d'entrée virtuelles sont triées dans l'objet IDTSVirtualInput100.
Name	Obtient ou définit le nom d'un objet IDTSVirtualInput100.
ObjectType	Obtient l'objet DTSObjectType d'un objet IDTSVirtualInput100.
SourceLocale	Obtient l'ID de paramètres régionaux (LCID) de la source de l'objet IDTSVirtualInput100.
VirtualInputColumnCollection	Obtient l'objet IDTSVirtualInputColumnCollection100 d'un objet IDTSVirtualInput100.

Méthodes

SetUsageType(Int32, DTSUsageType)

Mappe un objet de colonne d'entrée virtuelle et définit son type d'utilisation.