IDTSComponentMetaData100.GetComponentView Method
Gets the IDTSComponentView100 interface for a component, which supports transactional edits of the component metadata.
Namespace: Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly: Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)
Syntax
'Declaration
Function GetComponentView As IDTSComponentView100
'Usage
Dim instance As IDTSComponentMetaData100
Dim returnValue As IDTSComponentView100
returnValue = instance.GetComponentView()
IDTSComponentView100 GetComponentView()
IDTSComponentView100^ GetComponentView()
abstract GetComponentView : unit -> IDTSComponentView100
function GetComponentView() : IDTSComponentView100
Return Value
Type: Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSComponentView100
The IDTSComponentView100 interface of the component.
Remarks
This method is called to retrieve the IDTSComponentView100 interface of the component. This interface allows transactional modifications to be made to the component metadata. The component metadata modifications are persisted when the Commit method is called, and reverted when the Cancel method is called.
Examples
The following code example demonstrates how the GetComponentView method is used.
using System;
using Microsoft.SqlServer.Dts.Runtime;
using Microsoft.SqlServer.Dts.Pipeline.Wrapper;
namespace Microsoft.Samples.SqlServer.Dts
{
public class Class1
{
public static void Main(string []args)
{
// Create the package.
Package p = new Package();
// Add the data flow task.
MainPipe mp = ((TaskHost)p.Executables.Add("DTS.Pipeline")).InnerObject as MainPipe;
// Add the OLEDB Source component.
IDTSComponentMetaData100 mdOleDbSrc = mp.ComponentMetaDataCollection.New();
mdOleDbSrc.ComponentClassID = "DTSAdapter.OleDbSource";
mdOleDbSrc.Name = "OLEDB Source";
IDTSComponentView100 oledbView = mdOleDbSrc.GetComponentView();
mdOleDbSrc.Name = "The OLEDB Source Component";
Console.WriteLine(mdOleDbSrc.Name);
oledbView.Cancel();
Console.WriteLine(mdOleDbSrc.Name);
}
}
}
Imports System
Imports Microsoft.SqlServer.Dts.Runtime
Imports Microsoft.SqlServer.Dts.Pipeline.Wrapper
Namespace Microsoft.Samples.SqlServer.Dts
Public Class Class1
Public Shared Sub Main(ByVal args As String())
Dim p As Package = New Package
Dim mp As MainPipe = CType(CType(p.Executables.Add("DTS.Pipeline").InnerObject, TaskHost), MainPipe)
Dim mdOleDbSrc As IDTSComponentMetaData100 = mp.ComponentMetaDataCollection.New
mdOleDbSrc.ComponentClassID = "DTSAdapter.OleDbSource"
mdOleDbSrc.Name = "OLEDB Source"
Dim oledbView As IDTSComponentView100 = mdOleDbSrc.GetComponentView
mdOleDbSrc.Name = "The OLEDB Source Component"
Console.WriteLine(mdOleDbSrc.Name)
oledbView.Cancel
Console.WriteLine(mdOleDbSrc.Name)
End Sub
End Class
End Namespace
The following output is generated by the above code example.
The OLEDB Source Component
OLEDB Source