ScriptComponent 类

Serves as the base class for the read-only UserComponent class generated by the Script component in the ComponentWrapper project item in a Script component project.

继承层次结构

System.Object
  Microsoft.SqlServer.Dts.Pipeline.ScriptComponent

命名空间：  Microsoft.SqlServer.Dts.Pipeline
程序集：  Microsoft.SqlServer.TxScript（在 Microsoft.SqlServer.TxScript.dll 中）

语法

声明
Public Class ScriptComponent
用法
Dim instance As ScriptComponent

public class ScriptComponent

public ref class ScriptComponent

type ScriptComponent =  class end

public class ScriptComponent

ScriptComponent 类型公开以下成员。

构造函数

	名称	说明
	ScriptComponent	Initializes a new instance of the ScriptComponent class.

页首

属性

	名称	说明
	ComponentMetaData	Returns a reference to the component definition.
	EvaluatorContext	Gets the script component evaluator context.
	InputIDToNameMap	Gets the input identifier to name map.
	OutputNameMap	Gets the output name map.
	ReadOnlyVariables	Returns the collection of ReadOnlyVariables available to the component.
	ReadWriteVariables	Returns the collection of ReadWriteVariables available to the component.
	VariableDispenser	Returns an object that the data flow uses internally to work with variables.

页首

方法

	名称	说明
	AcquireConnections	Obtains a connection or connection information by using a connection manager.
	Equals	（从 Object 继承。）
	Finalize	（从 Object 继承。）
	GetColumnIndexes	基础结构。Gets the collection of column index for the script component.
	GetHashCode	（从 Object 继承。）
	GetOutputID	Returns the output ID that has a specified output name.
	GetType	（从 Object 继承。）
	Log	Writes a log entry.
	MemberwiseClone	（从 Object 继承。）
	PostExecute	Executes custom code that must run after the Script component has processed its inputs and outputs.
	PreExecute	Executes custom code that must run before the Script component has processed its inputs and outputs.
	PrimeOutput	Prepares the outputs in Script components, such as sources and transformations with asynchronous outputs, that add new rows to the output buffers.
	ProcessInput(Int32, PipelineBuffer)	Processes the inputs in Script components, such as transformations and destinations, that receive inputs from upstream components.
	ProcessInput(Int32, String, PipelineBuffer, OutputNameMap)	Processes inputs in the script components.
	ReleaseConnections	Releases a connection to a connection manager.
	SetBufferColumnIndexes	基础结构。Sets the index of the buffer columns.
	ToString	（从 Object 继承。）

页首

注释

The ScriptComponent class serves as the base class for the read-only UserComponent class, which is generated by the Script component in the ComponentWrapper project item in a Script component project. The UserComponent class serves as the base class for the ScriptMain class, in which the developer writes custom code, and provides the developer with a set of methods for working with the component's inputs and outputs. It also provides strongly-typed accessor properties for variables and connection managers available to the component.

The Script component developer does not use the ScriptComponent class directly, but indirectly, by coding the methods and properties of the ScriptMain class, which inherits from ScriptComponent through the UserComponent class.

For more information, see 脚本组件的编码和调试 and 了解脚本组件对象模型.

示例

The following code sample demonstrates all the code that a developer has to write to create a transformation with synchronous outputs by using the Script component. For more information on this sample, see 使用脚本组件创建同步转换.

Public Class ScriptMain
    Inherits UserComponent

    Public Overrides Sub MyAddressInput_ProcessInputRow(ByVal Row As MyAddressInputBuffer)

        Row.City = UCase(Row.City)

    End Sub

End Class

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.SqlServer.Dts.Pipeline 命名空间