IDTSPath100 Interface

Represents a connection between two components.

Namespace:  Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly:  Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)

Syntax

'Declaration
<GuidAttribute("172066DC-24EE-4569-B224-17A457249876")> _
Public Interface IDTSPath100 _
    Inherits IDTSObject100
'Usage
Dim instance As IDTSPath100

[GuidAttribute("172066DC-24EE-4569-B224-17A457249876")]
public interface IDTSPath100 : IDTSObject100

[GuidAttribute(L"172066DC-24EE-4569-B224-17A457249876")]
public interface class IDTSPath100 : IDTSObject100

[<GuidAttribute("172066DC-24EE-4569-B224-17A457249876")>]
type IDTSPath100 =  
    interface
        interface IDTSObject100
    end

public interface IDTSPath100 extends IDTSObject100

The IDTSPath100 type exposes the following members.

Properties

	Name	Description
	Description	Gets or sets the description of an IDTSObject100. (Inherited from IDTSObject100.)
	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 IDTSObject100object. (Inherited from IDTSObject100.)
	ID	Gets or sets the ID of an IDTSPath100 object.
	IdentificationString	Gets a string that uniquely identifies an IDTSObject100. (Inherited from IDTSObject100.)
	IdentificationString	Gets a unique string that identifies an IDTSPath100 object.
	Name	Gets or sets the name of an IDTSObject100 object. (Inherited from IDTSObject100.)
	Name	Gets or sets the string identifier of an IDTSPath100 object.
	ObjectType	Gets the ObjectType property of an IDTSObject100. (Inherited from IDTSObject100.)
	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.

Top

Methods

	Name	Description
	AttachPathAndPropagateNotifications	Establishes a path between two components and notifies the affected components.

Top

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.

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

See Also

Reference

Microsoft.SqlServer.Dts.Pipeline.Wrapper Namespace