IDTSComponentMetaData90.GetComponentView Method
Gets the IDTSComponentView90 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
<DispIdAttribute(119)> _
Function GetComponentView As IDTSComponentView90
[DispIdAttribute(119)]
IDTSComponentView90 GetComponentView ()
[DispIdAttribute(119)]
IDTSComponentView90^ GetComponentView ()
/** @attribute DispIdAttribute(119) */
IDTSComponentView90 GetComponentView ()
DispIdAttribute(119)
function GetComponentView () : IDTSComponentView90
Return Value
The IDTSComponentView90 interface of the component.
Remarks
This method is called to retrieve the IDTSComponentView90 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.
Example
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.
IDTSComponentMetaData90 mdOleDbSrc = mp.ComponentMetaDataCollection.New();
mdOleDbSrc.ComponentClassID = "DTSAdapter.OleDbSource";
mdOleDbSrc.Name = "OLEDB Source";
IDTSComponentView90 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 IDTSComponentMetaData90 = mp.ComponentMetaDataCollection.New
mdOleDbSrc.ComponentClassID = "DTSAdapter.OleDbSource"
mdOleDbSrc.Name = "OLEDB Source"
Dim oledbView As IDTSComponentView90 = 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
Thread Safety
Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms
Development Platforms
For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.
Target Platforms
For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.
See Also
Reference
IDTSComponentMetaData90 Interface
IDTSComponentMetaData90 Members
Microsoft.SqlServer.Dts.Pipeline.Wrapper Namespace