IDTSComponentMetaData130.GetIdentificationStringByID(Int32) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Pipeline.Wrapper

Assembly:: Microsoft.SqlServer.DTSPipelineWrap.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.

Gets the identification string for a column referenced in an error output by providing a valid ID for the column.

public:
 System::String ^ GetIdentificationStringByID(int lID);

[System.Runtime.InteropServices.DispId(135)]
public string GetIdentificationStringByID (int lID);

[<System.Runtime.InteropServices.DispId(135)>]
abstract member GetIdentificationStringByID : int -> string

Public Function GetIdentificationStringByID (lID As Integer) As String

Parameters

lID: Int32

A valid ID for the column.

Returns

String

The identification string for the column. Here is an example of an identification string.OLE DB Source.Outputs[OLE DB Source Output].Columns[UserID]

Attributes: DispIdAttribute

Remarks

When you redirect rows in the data flow that contain errors to an error output, the output contains a numeric identifier for the column in which the error occurred, but does not display the name of the column. Call GetIdentificationStringByID from the Script Component or from a custom data flow component to get the name of the column, which is part of the identification string returned by this method.

For more info, see Error Handling in Data and Enhancing an Error Output with the Script Component.

Applies to