共用方式為


PipelineComponent 類別

Defines the base class that is used when developing managed data flow components.

繼承階層

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

命名空間:  Microsoft.SqlServer.Dts.Pipeline
組件:  Microsoft.SqlServer.PipelineHost (在 Microsoft.SqlServer.PipelineHost.dll 中)

語法

'宣告
Public Class PipelineComponent
'用途
Dim instance As PipelineComponent
public class PipelineComponent
public ref class PipelineComponent
type PipelineComponent =  class end
public class PipelineComponent

PipelineComponent 型別公開下列成員。

建構函式

  名稱 說明
公用方法 PipelineComponent Initializes a new instance of the PipelineComponent class.

上層

屬性

  名稱 說明
公用屬性 BufferManager Gets the IDTSBufferManager100 of the pipeline component.
公用屬性 ComponentMetaData Gets the IDTSComponentMetaData100 for a component.
公用屬性 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.
公用屬性 EventInfos Gets the IDTSEventInfos100 collection of the PipelineComponent object.
公用屬性 LogEntryInfos Gets an IDTSLogEntryInfos100 collection of logging events that the component has registered.
公用屬性 ReferenceTracker Gets the IDTSObjectReferenceTracker100 associated with the component.
公用屬性 VariableDispenser Gets the IDTSVariableDispenser100 of the data flow component.

上層

方法

  名稱 說明
公用方法 AcquireConnections Establishes a connection to a connection manager.
公用方法 AddErrorOutput Adds an IDTSOutput100 object and marks it as an error output by setting the IsErrorOut property to true.
受保護的方法靜態成員 BufferTypeToDataRecordType Returns a managed data type based on an Integration Services data type.
公用方法 Cleanup Frees resources and finishes the execution of the component.
受保護的方法靜態成員 ConvertBufferDataTypeToFitManaged Gets the appropriate Integration Services DataType from managed code.
受保護的方法靜態成員 DataRecordTypeToBufferType Gets the Integration Services DataType that corresponds to a managed type.
公用方法 DeleteExternalMetadataColumn Deletes the external metadata column at the specified index from the collection of external metadata columns.
公用方法 DeleteInput Deletes an IDTSInput100 object from the IDTSInputCollection100 collection.
公用方法 DeleteOutput Deletes an IDTSOutput100 object from the IDTSOutputCollection100 collection.
公用方法 DeleteOutputColumn Deletes an IDTSOutputColumn100 object from the IDTSOutputColumnCollection100 collection.
公用方法 DescribeRedirectedErrorCode Provides error code information for a PipelineBuffer row added to an output buffer.
公用方法 Equals (繼承自 Object。)
受保護的方法 Finalize (繼承自 Object。)
公用方法 GetDependentInputs Returns a collection of the input IDs of inputs that are waiting for more data, and thus are blocking the specified input.
公用方法 GetErrorOutputInfo Returns the index and ID of the error output of the component.
公用方法 GetHashCode (繼承自 Object。)
公用方法 GetType (繼承自 Object。)
受保護的方法靜態成員 idxOfBufferType 基礎結構。Specifies the type of the buffer index.
受保護的方法靜態成員 idxOfDataRecordType 基礎結構。Specifies the type of the data record index.
公用方法 Initialize When overridden in a derived class, initializes a new instance of a custom data flow component.
公用方法 InsertExternalMetadataColumnAt Inserts a new external metadata column into the collection of external metadata columns at the specified index.
公用方法 InsertInput Adds an IDTSInput100 object to the IDTSInputCollection100.
公用方法 InsertOutput Adds a new IDTSOutput100 object
公用方法 InsertOutputColumnAt Creates a new IDTSOutputColumn100 object and inserts it into the IDTSOutputColumnCollection100.
受保護的方法靜態成員 IsCompatibleNumericTypes Determines whether two numeric data types are compatible to support a conversion from one type to the other.
公用方法 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.
公用方法 MapInputColumn Establishes a relationship between an input column and a corresponding external metadata column.
公用方法 MapOutputColumn Establishes a relationship between an output column and a corresponding external metadata column.
受保護的方法 MemberwiseClone (繼承自 Object。)
公用方法 OnDeletingInputColumn Deletes an IDTSInputColumn100 object from the IDTSInputColumnCollection100.
公用方法 OnInputPathAttached Called when an IDTSInput100 object is connected to the component through the IDTSPath100 interface.
公用方法 OnInputPathDetached Called when an IDTSInput100 object is disconnected from the component through the IDTSPath100 interface.
公用方法 OnOutputPathAttached Called when an IDTSOutput100 object of the component is attached to a downstream component.
公用方法 PerformUpgrade Upgrades the component metadata to the version of the component installed on the local computer.
公用方法 PostExecute Called at the end of component execution, but before Cleanup.
公用方法 PreExecute Called after PrepareForExecute, and before PrimeOutput and ProcessInput.
公用方法 PrepareForExecute Called before PreExecute.
公用方法 PrimeOutput Called at run time for source components and transformation components with asynchronous outputs to let these components add rows to the output buffers.
公用方法 ProcessInput Called at run time when a PipelineBuffer from an upstream component is available to the component to let the component process the incoming rows.
公用方法 ProvideComponentProperties Called when a component is first added to the data flow task, to initialize the ComponentMetaData of the component.
公用方法 RegisterEvents When you are developing a custom data flow component, you override this method to create custom events.
公用方法 RegisterLogEntries Registers the events that the component will log.
公用方法 ReinitializeMetaData Repairs any errors identified during validation that cause the component to return VS_NEEDSNEWMETADATA at design time.
公用方法 ReleaseConnections Frees the connections established during AcquireConnections. Called at design time and run time.
公用方法 RemoveAllInputsOutputsAndCustomProperties Deletes each IDTSInput100 and IDTSOutput100 object from the component.
公用方法 SetComponentProperty Assigns a value to a IDTSCustomProperty100 of the component.
公用方法 SetExternalMetadataColumnDataTypeProperties Sets the data type properties of the specified external metadata column.
公用方法 SetExternalMetadataColumnProperty Sets an individual property of an external metadata column.
公用方法 SetInputColumnProperty Assigns a value to the IDTSCustomProperty100 of an IDTSInputColumn100 object.
公用方法 SetInputProperty Assigns a value to the IDTSCustomProperty100 of an IDTSInput100 object.
公用方法 SetOutputColumnDataTypeProperties Sets the data type properties of an IDTSOutputColumn100 object.
公用方法 SetOutputColumnProperty Sets the value of an IDTSCustomProperty100 for an IDTSOutputColumn100 object.
公用方法 SetOutputProperty Sets the value of an IDTSCustomProperty100 on an IDTSOutput100 object.
公用方法 SetUsageType Creates an IDTSInputColumn100 object in the IDTSInputColumnCollection100 of the component and sets the UsageType property of the column.
公用方法 ToString (繼承自 Object。)
公用方法 Validate Verifies that the component is correctly configured.

上層

欄位

  名稱 說明
公用欄位靜態成員 s_STOCKPROPNAME_COMPFLAGS Contains the name of the ComparisonFlags property of data flow components.
公用欄位靜態成員 s_STOCKPROPNAME_DELOUTPUTONPATHDETACHED Contains the name of the DeleteOutputOnPathDetached property of data flow components.
公用欄位靜態成員 s_STOCKPROPNAME_EXCLGROUP Contains the name of the ExclusionGroup property of data flow components.
公用欄位靜態成員 s_STOCKPROPNAME_HASSIDEEFFECTS Contains the name of the HasSideEffects property of data flow components.
公用欄位靜態成員 s_STOCKPROPNAME_ISDISTRIBUTABLE Contains the name of the IsDistributable property of data flow components.
公用欄位靜態成員 s_STOCKPROPNAME_ISERROROUT Contains the name of the IsErrorOut property of data flow components.
公用欄位靜態成員 s_STOCKPROPNAME_ISSORTED Contains the name of the IsSorted property of data flow components.
公用欄位靜態成員 s_STOCKPROPNAME_REFMETADATAID Contains the name of the ReferenceMetaDataID property of data flow components.
公用欄位靜態成員 s_STOCKPROPNAME_SORTKEYPOS Contains the name of the SortKeyPosition property of data flow components.
公用欄位靜態成員 s_STOCKPROPNAME_SYNCINPUTID Contains the name of the SynchronousInputID property of data flow components.

上層

備註

Inherit from this class to create your own data flow component. This class implements the required component interfaces, IDTSDesigntimeComponent100 and IDTSRuntimeComponent100. You override the base class implementation of these methods to provide the functionality of your component. PipelineComponent provides helper methods in addition to the methods of the component interfaces to help you in developing your component.

範例

The following code example shows a component that implements the DtsPipelineComponentAttribute and inherits from the PipelineComponent class.

using System;
using Microsoft.SqlServer.Dts.Pipeline.Wrapper;
namespace Microsoft.Samples.SqlServer.Dts
{
    [DtsPipelineComponent(DisplayName="SampleComponent")]
    public class SampleComponent : PipelineComponent
    {
        public override ProvideComponentProperties()
        {
            // TODO: Implement component intialization.
        }
        public override DTSValidationStatus Validate()
        {
            // TODO: Implement component validation.
        }
        public override void ProcessInput( int inputID, PipelineBuffer buffer)
        {
            // TODO: For transformation and destination components,
            //  implement code to process incoming rows.
        }
    }
}
Imports System 
Imports Microsoft.SqlServer.Dts.Pipeline.Wrapper 
Namespace Microsoft.Samples.SqlServer.Dts 

 <DtsPipelineComponent(DisplayName="SampleComponent")> _ 
 Public Class SampleComponent 
 Inherits PipelineComponent 

   Public Overrides Sub ProvideComponentProperties() 
    ' TODO: Implement component intialization.
   End Sub 

   Public Overrides Function Validate() As DTSValidationStatus 
    ' TODO: Implement component validation.
   End Function 

   Public Overrides Sub ProcessInput(ByVal inputID As Integer, ByVal buffer As PipelineBuffer) 
    ' TODO: For transformation and destination components,
    '  implement code to process incoming rows.
   End Sub 
 End Class 
End Namespace

執行緒安全性

這個型別的任何公用 static (在 Visual Basic 中為 Shared) 成員都是執行緒安全的。並不是所有的執行個體成員都保證可以用於所有的執行緒。

請參閱

參考

Microsoft.SqlServer.Dts.Pipeline 命名空間