ScriptComponentHost Class

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Pipeline

Assembly:: Microsoft.SqlServer.TxScript.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

DTS pipeline component that sources records from the managed provider.

public ref class ScriptComponentHost : Microsoft::SqlServer::Dts::Pipeline::PipelineComponent, Microsoft::SqlServer::Dts::Pipeline::IVSTAScriptComponentUI

[Microsoft.SqlServer.Dts.Pipeline.DtsPipelineComponent(ComponentType=Microsoft.SqlServer.Dts.Pipeline.ComponentType.Transform, CurrentVersion=10, HelpKeyword="sql13.dts.designer.scriptcomponentdetails.f1", IconResource="Microsoft.SqlServer.Dts.Pipeline.ScriptComponent.ico", LocalizationType=typeof(Microsoft.SqlServer.Dts.Pipeline.Localized), SamplesTag="SsisScriptComponentTransform", UITypeName="Microsoft.DataTransformationServices.DataFlowUI.ScriptUI, Microsoft.DatatransformationServices.DataFlowUI, Version=13.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")]
public class ScriptComponentHost : Microsoft.SqlServer.Dts.Pipeline.PipelineComponent, Microsoft.SqlServer.Dts.Pipeline.IVSTAScriptComponentUI

[Microsoft.SqlServer.Dts.Pipeline.DtsPipelineComponent(ComponentType=Microsoft.SqlServer.Dts.Pipeline.ComponentType.Transform, CurrentVersion=11, HelpKeyword="sql13.dts.designer.scriptcomponentdetails.f1", IconResource="Microsoft.SqlServer.Dts.Pipeline.ScriptComponent.ico", LocalizationType=typeof(Microsoft.SqlServer.Dts.Pipeline.Localized), SamplesTag="SsisScriptComponentTransform", UITypeName="Microsoft.DataTransformationServices.DataFlowUI.ScriptUI, Microsoft.DatatransformationServices.DataFlowUI, Version=14.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")]
public class ScriptComponentHost : Microsoft.SqlServer.Dts.Pipeline.PipelineComponent, Microsoft.SqlServer.Dts.Pipeline.IVSTAScriptComponentUI

[Microsoft.SqlServer.Dts.Pipeline.DtsPipelineComponent(ComponentType=Microsoft.SqlServer.Dts.Pipeline.ComponentType.Transform, CurrentVersion=12, HelpKeyword="sql13.dts.designer.scriptcomponentdetails.f1", IconResource="Microsoft.SqlServer.Dts.Pipeline.ScriptComponent.ico", LocalizationType=typeof(Microsoft.SqlServer.Dts.Pipeline.Localized), SamplesTag="SsisScriptComponentTransform", UITypeName="Microsoft.DataTransformationServices.DataFlowUI.ScriptUI, Microsoft.DatatransformationServices.DataFlowUI, Version=15.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")]
public class ScriptComponentHost : Microsoft.SqlServer.Dts.Pipeline.PipelineComponent, Microsoft.SqlServer.Dts.Pipeline.IVSTAScriptComponentUI

[<Microsoft.SqlServer.Dts.Pipeline.DtsPipelineComponent(ComponentType=Microsoft.SqlServer.Dts.Pipeline.ComponentType.Transform, CurrentVersion=10, HelpKeyword="sql13.dts.designer.scriptcomponentdetails.f1", IconResource="Microsoft.SqlServer.Dts.Pipeline.ScriptComponent.ico", LocalizationType=typeof(Microsoft.SqlServer.Dts.Pipeline.Localized), SamplesTag="SsisScriptComponentTransform", UITypeName="Microsoft.DataTransformationServices.DataFlowUI.ScriptUI, Microsoft.DatatransformationServices.DataFlowUI, Version=13.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")>]
type ScriptComponentHost = class
    inherit PipelineComponent
    interface IVSTAScriptComponentUI

[<Microsoft.SqlServer.Dts.Pipeline.DtsPipelineComponent(ComponentType=Microsoft.SqlServer.Dts.Pipeline.ComponentType.Transform, CurrentVersion=11, HelpKeyword="sql13.dts.designer.scriptcomponentdetails.f1", IconResource="Microsoft.SqlServer.Dts.Pipeline.ScriptComponent.ico", LocalizationType=typeof(Microsoft.SqlServer.Dts.Pipeline.Localized), SamplesTag="SsisScriptComponentTransform", UITypeName="Microsoft.DataTransformationServices.DataFlowUI.ScriptUI, Microsoft.DatatransformationServices.DataFlowUI, Version=14.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")>]
type ScriptComponentHost = class
    inherit PipelineComponent
    interface IVSTAScriptComponentUI

[<Microsoft.SqlServer.Dts.Pipeline.DtsPipelineComponent(ComponentType=Microsoft.SqlServer.Dts.Pipeline.ComponentType.Transform, CurrentVersion=12, HelpKeyword="sql13.dts.designer.scriptcomponentdetails.f1", IconResource="Microsoft.SqlServer.Dts.Pipeline.ScriptComponent.ico", LocalizationType=typeof(Microsoft.SqlServer.Dts.Pipeline.Localized), SamplesTag="SsisScriptComponentTransform", UITypeName="Microsoft.DataTransformationServices.DataFlowUI.ScriptUI, Microsoft.DatatransformationServices.DataFlowUI, Version=15.0.0.0, Culture=neutral, PublicKeyToken=89845dcd8080cc91")>]
type ScriptComponentHost = class
    inherit PipelineComponent
    interface IVSTAScriptComponentUI

Public Class ScriptComponentHost
Inherits PipelineComponent
Implements IVSTAScriptComponentUI

Inheritance: Object

PipelineComponent
ScriptComponentHost

Attributes: DtsPipelineComponentAttribute

Implements: IVSTAScriptComponentUI

Constructors

ScriptComponentHost()

Properties

BufferManager	Gets the IDTSBufferManager100 of the pipeline component. (Inherited from PipelineComponent)
ComponentMetaData	Gets the IDTSComponentMetaData100 for a component. (Inherited from PipelineComponent)
CurrentScriptingEngine
ErrorSupport	Returns an ErrorSupport object that lets the component raise errors, warnings, or other information events based on HRESULTs returned by Integration Services components written in native code. (Inherited from PipelineComponent)
EventInfos	Gets the IDTSEventInfos100 collection of the PipelineComponent object. (Inherited from PipelineComponent)
LogEntryInfos	Gets an IDTSLogEntryInfos100 collection of logging events that the component has registered. (Inherited from PipelineComponent)
ProjectTemplatePath
ReferenceTracker	Gets the IDTSObjectReferenceTracker100 associated with the component. (Inherited from PipelineComponent)
VariableDispenser	Gets the IDTSVariableDispenser100 of the data flow component. (Inherited from PipelineComponent)

Methods

AcquireConnections(Object)
AddErrorOutput(String, Int32, Int32)	Adds an IDTSOutput100 object and marks it as an error output by setting the IsErrorOut property to true. (Inherited from PipelineComponent)
Cleanup()
CloseIDE()
CreateNewProject(String, Boolean, Boolean)
DeleteExternalMetadataColumn(Int32, Int32)	Deletes the external metadata column at the specified index from the collection of external metadata columns. (Inherited from PipelineComponent)
DeleteInput(Int32)	Deletes an IDTSInput100 object from the IDTSInputCollection100 collection. (Inherited from PipelineComponent)
DeleteOutput(Int32)	Deletes an IDTSOutput100 object from the IDTSOutputCollection100 collection. (Inherited from PipelineComponent)
DeleteOutputColumn(Int32, Int32)	Deletes an IDTSOutputColumn100 object from the IDTSOutputColumnCollection100 collection. (Inherited from PipelineComponent)
DescribeRedirectedErrorCode(Int32)	Provides error code information for a PipelineBuffer row added to an output buffer. (Inherited from PipelineComponent)
GetBinaryCode(String)
GetDependentInputs(Int32)	Returns a collection of the input IDs of inputs that are waiting for more data, and thus are blocking the specified input. (Inherited from PipelineComponent)
GetErrorOutputInfo(Int32, Int32)	Returns the index and ID of the error output of the component. (Inherited from PipelineComponent)
GetUniqueVSTAProjectName()
Initialize()	When overridden in a derived class, initializes a new instance of a custom data flow component. (Inherited from PipelineComponent)
InsertExternalMetadataColumnAt(Int32, Int32, String, String)	Inserts a new external metadata column into the collection of external metadata columns at the specified index. (Inherited from PipelineComponent)
InsertInput(DTSInsertPlacement, Int32)
InsertOutput(DTSInsertPlacement, Int32)
InsertOutputColumnAt(Int32, Int32, String, String)
IsInputReady(Int32[], Boolean[])	Determines which of the inputs attached to a component are waiting for more data, and which have enough data to process and are blocked. (Inherited from PipelineComponent)
LoadScriptFromComponent()	Loads the script code and binary from the component custom property collection and puts it in the script storage
MapInputColumn(Int32, Int32, Int32)	Establishes a relationship between an input column and a corresponding external metadata column. (Inherited from PipelineComponent)
MapOutputColumn(Int32, Int32, Int32, Boolean)	Establishes a relationship between an output column and a corresponding external metadata column. (Inherited from PipelineComponent)
OnDeletingInputColumn(Int32, Int32)	Deletes an IDTSInputColumn100 object from the IDTSInputColumnCollection100. (Inherited from PipelineComponent)
OnInputPathAttached(Int32)	Called when an IDTSInput100 object is connected to the component through the IDTSPath100 interface. (Inherited from PipelineComponent)
OnInputPathDetached(Int32)	Called when an IDTSInput100 object is disconnected from the component through the IDTSPath100 interface. (Inherited from PipelineComponent)
OnOutputPathAttached(Int32)	Called when an IDTSOutput100 object of the component is attached to a downstream component. (Inherited from PipelineComponent)
PerformDowngrade(Int32, DTSTargetServerVersion)
PerformUpgrade(Int32)
PostExecute()
PreExecute()
PrepareForExecute()
PrimeOutput(Int32, Int32[], PipelineBuffer[])
ProcessInput(Int32, PipelineBuffer)
ProvideComponentProperties()
PutBinaryCode(String, Byte[])
PutSourceCode(String, String, String)
RegisterEvents()	When you are developing a custom data flow component, you override this method to create custom events. (Inherited from PipelineComponent)
RegisterLogEntries()
ReinitializeMetaData()	Repairs any errors identified during validation that cause the component to return VS_NEEDSNEWMETADATA at design time. (Inherited from PipelineComponent)
ReleaseConnections()
RemoveAllInputsOutputsAndCustomProperties()	Deletes each IDTSInput100 and IDTSOutput100 object from the component. (Inherited from PipelineComponent)
SaveScriptProject()
SetComponentProperty(String, Object)
SetExternalMetadataColumnDataTypeProperties(Int32, Int32, DataType, Int32, Int32, Int32, Int32)	Sets the data type properties of the specified external metadata column. (Inherited from PipelineComponent)
SetExternalMetadataColumnProperty(Int32, Int32, String, Object)	Sets an individual property of an external metadata column. (Inherited from PipelineComponent)
SetInputColumnProperty(Int32, Int32, String, Object)	Assigns a value to the IDTSCustomProperty100 of an IDTSInputColumn100 object. (Inherited from PipelineComponent)
SetInputProperty(Int32, String, Object)	Assigns a value to the IDTSCustomProperty100 of an IDTSInput100 object. (Inherited from PipelineComponent)
SetOutputColumnDataTypeProperties(Int32, Int32, DataType, Int32, Int32, Int32, Int32)
SetOutputColumnProperty(Int32, Int32, String, Object)	Sets the value of an IDTSCustomProperty100 for an IDTSOutputColumn100 object. (Inherited from PipelineComponent)
SetOutputProperty(Int32, String, Object)	Sets the value of an IDTSCustomProperty100 on an IDTSOutput100 object. (Inherited from PipelineComponent)
SetUsageType(Int32, IDTSVirtualInput100, Int32, DTSUsageType)	Creates an IDTSInputColumn100 object in the IDTSInputColumnCollection100 of the component and sets the UsageType property of the column. (Inherited from PipelineComponent)
ShowIDE()
Validate()

Applies to

Share via