IDTSPath100 Interface

Definition

Namespace:

Microsoft.SqlServer.Dts.Pipeline.Wrapper

Assembly:

Microsoft.SqlServer.DTSPipelineWrap.dll

Represents a connection between two components.

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

[System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)]
[System.Runtime.InteropServices.Guid("4256D17F-7FD3-49F4-8764-0C16B29CD442")]
public interface IDTSPath100 : Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSObject100

[<System.Runtime.InteropServices.TypeLibType(System.Runtime.InteropServices.TypeLibTypeFlags.FDispatchable | System.Runtime.InteropServices.TypeLibTypeFlags.FDual)>]
[<System.Runtime.InteropServices.Guid("4256D17F-7FD3-49F4-8764-0C16B29CD442")>]
type IDTSPath100 = interface
    interface IDTSObject100

Public Interface IDTSPath100
Implements IDTSObject100

Attributes

GuidAttribute TypeLibTypeAttribute

Implements

IDTSObject100

Examples

The following code example demonstrates how to create a new IDTSPath100 object, and then attach the output of the upstream component to the input of the downstream component.

public IDTSPath100 EstablishPath( MainPipe mp , IDTSOutput100 start , IDTSInput100 end )  
{  
IDTSPath100 path = mp.PathCollection.New();  
path.AttachPathAndPropagateNotifications( start, end );  
return path;  
}  

Public Function EstablishPath(ByVal mp As MainPipe, ByVal start As IDTSOutput100, ByVal end As IDTSInput100) As IDTSPath100   
 Dim path As IDTSPath100 = mp.PathCollection.New   
 path.AttachPathAndPropagateNotifications(start, end)   
 Return path   
End Function  

Remarks

Path objects are created to establish the flow of data between the IDTSOutput100 of an upstream component and the IDTSInput100 of another component. A path contains a single output object represented as the StartPoint, and a single input, which is the EndPoint of the path. A path between two components is established in a two-step process. First, create the path by calling New on the path collection of the IDTSComponentMetaData100 object. Second, establish the path by calling AttachPathAndPropagateNotifications on the path itself. This method establishes the path and notifies the affected components of its existence.

The columns of the StartPoint are subsequently mapped to the EndPoint by calling SetUsageType.

Properties

Description	Gets or sets the description of the IDTSPath100 object.
EndPoint	Gets or sets the IDTSInput100 object associated with a path.
ID	Gets or sets the ID of an IDTSPath100 object.
IdentificationString	Gets a unique string that identifies an IDTSPath100 object.
Name	Gets or sets the string identifier of an IDTSPath100 object.
ObjectType	Returns a value from the DTSObjectType enumeration.
StartPoint	Gets or sets the IDTSOutput100 object associated with a path.
Visualized	Sets a value indicating that the user has attached a data viewer to this path in SSIS Designer.

Methods

AttachPathAndPropagateNotifications(IDTSOutput100, IDTSInput100)

Establishes a path between two components and notifies the affected components.