ScriptComponentHost Class

Article
04/26/2013

This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.

Represents the host for the script component.

Inheritance Hierarchy

System.Object
Microsoft.SqlServer.Dts.Pipeline.PipelineComponent
Microsoft.SqlServer.Dts.Pipeline.ScriptComponentHost

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

Syntax

'Declaration
Public Class ScriptComponentHost _
    Inherits PipelineComponent _
    Implements IVSTAScriptComponentUI
'Usage
Dim instance As ScriptComponentHost

public class ScriptComponentHost : PipelineComponent, 
    IVSTAScriptComponentUI

public ref class ScriptComponentHost : public PipelineComponent, 
    IVSTAScriptComponentUI

type ScriptComponentHost =  
    class 
        inherit PipelineComponent 
        interface IVSTAScriptComponentUI 
    end

public class ScriptComponentHost extends PipelineComponent implements IVSTAScriptComponentUI

The ScriptComponentHost type exposes the following members.

Constructors

	Name	Description
	ScriptComponentHost	Infrastructure. Initializes a new instance of the ScriptComponentHost class.

Top

Properties

	Name	Description
	BufferManager	Gets the IDTSBufferManager100 of the pipeline component. (Inherited from PipelineComponent.)
	ComponentMetaData	Gets the IDTSComponentMetaData100 for a component. (Inherited from PipelineComponent.)
	CurrentScriptingEngine	Infrastructure. Gets the current scripting engine.
	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	Infrastructure. Gets the path of the current template.
	ReferenceTracker	Gets the IDTSObjectReferenceTracker100 associated with the component. (Inherited from PipelineComponent.)
	VariableDispenser	Gets the IDTSVariableDispenser100 of the data flow component. (Inherited from PipelineComponent.)

Top

Methods

	Name	Description
	AcquireConnections	Infrastructure. Acquires connection for ScriptComponentHost. (Overrides PipelineComponent.AcquireConnections(Object).)
	AddErrorOutput	Adds an IDTSOutput100 object and marks it as an error output by setting the IsErrorOut property to true. (Inherited from PipelineComponent.)
	Cleanup	Infrastructure. Performs a component host cleanup. (Overrides PipelineComponent.Cleanup().)
	CloseIDE	Infrastructure. Closes the IDE for the ScriptComponentHost.
	CreateNewProject	Infrastructure. Creates a new ScriptComponentHost project.
	DeleteExternalMetadataColumn	Deletes the external metadata column at the specified index from the collection of external metadata columns. (Inherited from PipelineComponent.)
	DeleteInput	Deletes an IDTSInput100 object from the IDTSInputCollection100 collection. (Inherited from PipelineComponent.)
	DeleteOutput	Deletes an IDTSOutput100 object from the IDTSOutputCollection100 collection. (Inherited from PipelineComponent.)
	DeleteOutputColumn	Deletes an IDTSOutputColumn100 object from the IDTSOutputColumnCollection100 collection. (Inherited from PipelineComponent.)
	DescribeRedirectedErrorCode	Provides error code information for a PipelineBuffer row added to an output buffer. (Inherited from PipelineComponent.)
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetBinaryCode	Infrastructure. Gets the collection of binary codes.
	GetDependentInputs	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	Returns the index and ID of the error output of the component. (Inherited from PipelineComponent.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	GetUniqueVSTAProjectName	Infrastructure. Gets the unique VSTA project name.
	Initialize	When overridden in a derived class, initializes a new instance of a custom data flow component. (Inherited from PipelineComponent.)
	InsertExternalMetadataColumnAt	Inserts a new external metadata column into the collection of external metadata columns at the specified index. (Inherited from PipelineComponent.)
	InsertInput	Infrastructure. Inserts input for the ScriptComponentHost. (Overrides PipelineComponent.InsertInput(DTSInsertPlacement, Int32).)
	InsertOutput	Infrastructure. Inserts a new output to the ScriptComponentHost. (Overrides PipelineComponent.InsertOutput(DTSInsertPlacement, Int32).)
	InsertOutputColumnAt	Infrastructure. Inserts an output at a specified column index. (Overrides PipelineComponent.InsertOutputColumnAt(Int32, Int32, String, String).)
	IsInputReady	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	Infrastructure. Loads script from component.
	MapInputColumn	Establishes a relationship between an input column and a corresponding external metadata column. (Inherited from PipelineComponent.)
	MapOutputColumn	Establishes a relationship between an output column and a corresponding external metadata column. (Inherited from PipelineComponent.)
	MemberwiseClone	(Inherited from Object.)
	OnDeletingInputColumn	Deletes an IDTSInputColumn100 object from the IDTSInputColumnCollection100. (Inherited from PipelineComponent.)
	OnInputPathAttached	Called when an IDTSInput100 object is connected to the component through the IDTSPath100 interface. (Inherited from PipelineComponent.)
	OnInputPathDetached	Called when an IDTSInput100 object is disconnected from the component through the IDTSPath100 interface. (Inherited from PipelineComponent.)
	OnOutputPathAttached	Called when an IDTSOutput100 object of the component is attached to a downstream component. (Inherited from PipelineComponent.)
	PerformUpgrade	Infrastructure. Performs a ScriptComponentHost upgrade. (Overrides PipelineComponent.PerformUpgrade(Int32).)
	PostExecute	Infrastructure. Specifies the ScriptComponentHost after execution. (Overrides PipelineComponent.PostExecute().)
	PreExecute	Infrastructure. Specifies the ScriptComponentHost before execution. (Overrides PipelineComponent.PreExecute().)
	PrepareForExecute	Infrastructure. Prepares the ScriptComponentHost before execution. (Overrides PipelineComponent.PrepareForExecute().)
	PrimeOutput	Infrastructure. Specifies the prime output for the ScriptComponentHost. (Overrides PipelineComponent.PrimeOutput(Int32, array<Int32[], array<PipelineBuffer[]).)
	ProcessInput	Infrastructure. Processes the ScriptComponentHost input. (Overrides PipelineComponent.ProcessInput(Int32, PipelineBuffer).)
	ProvideComponentProperties	Infrastructure. Provides properties for the ScriptComponentHost. (Overrides PipelineComponent.ProvideComponentProperties().)
	PutBinaryCode	Infrastructure. Puts binary codes in the ScriptComponentHost.
	PutSourceCode	Infrastructure. Puts source code to the ScriptComponentHost.
	RegisterEvents	When you are developing a custom data flow component, you override this method to create custom events. (Inherited from PipelineComponent.)
	RegisterLogEntries	Infrastructure. Registers log entries for the ScriptComponentHost. (Overrides PipelineComponent.RegisterLogEntries().)
	ReinitializeMetaData	Repairs any errors identified during validation that cause the component to return VS_NEEDSNEWMETADATA at design time. (Inherited from PipelineComponent.)
	ReleaseConnections	Infrastructure. Releases connection for the host. (Overrides PipelineComponent.ReleaseConnections().)
	RemoveAllInputsOutputsAndCustomProperties	Deletes each IDTSInput100 and IDTSOutput100 object from the component. (Inherited from PipelineComponent.)
	SaveScriptProject	Infrastructure. Saves the ScriptComponentHost script project.
	SetComponentProperty	Infrastructure. Sets the component property of the host. (Overrides PipelineComponent.SetComponentProperty(String, Object).)
	SetExternalMetadataColumnDataTypeProperties	Sets the data type properties of the specified external metadata column. (Inherited from PipelineComponent.)
	SetExternalMetadataColumnProperty	Sets an individual property of an external metadata column. (Inherited from PipelineComponent.)
	SetInputColumnProperty	Assigns a value to the IDTSCustomProperty100 of an IDTSInputColumn100 object. (Inherited from PipelineComponent.)
	SetInputProperty	Assigns a value to the IDTSCustomProperty100 of an IDTSInput100 object. (Inherited from PipelineComponent.)
	SetOutputColumnDataTypeProperties	Infrastructure. Sets the output column data type property for the component host. (Overrides PipelineComponent.SetOutputColumnDataTypeProperties(Int32, Int32, DataType, Int32, Int32, Int32, Int32).)
	SetOutputColumnProperty	Sets the value of an IDTSCustomProperty100 for an IDTSOutputColumn100 object. (Inherited from PipelineComponent.)
	SetOutputProperty	Sets the value of an IDTSCustomProperty100 on an IDTSOutput100 object. (Inherited from PipelineComponent.)
	SetUsageType	Creates an IDTSInputColumn100 object in the IDTSInputColumnCollection100 of the component and sets the UsageType property of the column. (Inherited from PipelineComponent.)
	ShowIDE	Infrastructure. Shows the IDE for the Component host.
	ToString	(Inherited from Object.)
	Validate	Infrastructure. Validates the component host. (Overrides PipelineComponent.Validate().)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via