Share via


ScriptComponentHost Class

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
Public method ScriptComponentHost Infrastructure. Initializes a new instance of the ScriptComponentHost class.

Top

Properties

  Name Description
Public property BufferManager Gets the IDTSBufferManager100 of the pipeline component. (Inherited from PipelineComponent.)
Public property ComponentMetaData Gets the IDTSComponentMetaData100 for a component. (Inherited from PipelineComponent.)
Public property CurrentScriptingEngine Infrastructure. Gets the current scripting engine.
Public property 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.)
Public property EventInfos Gets the IDTSEventInfos100 collection of the PipelineComponent object. (Inherited from PipelineComponent.)
Public property LogEntryInfos Gets an IDTSLogEntryInfos100 collection of logging events that the component has registered. (Inherited from PipelineComponent.)
Public property ProjectTemplatePath Infrastructure. Gets the path of the current template.
Public property ReferenceTracker Gets the IDTSObjectReferenceTracker100 associated with the component. (Inherited from PipelineComponent.)
Public property VariableDispenser Gets the IDTSVariableDispenser100 of the data flow component. (Inherited from PipelineComponent.)

Top

Methods

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

See Also

Reference

Microsoft.SqlServer.Dts.Pipeline Namespace