ErrorSupport Class

Definition

Supports the raising of errors, warnings, and other events that include descriptive text for known COM HRESULTs that are returned by Integration Services components written in native code.

public ref class ErrorSupport
[System.Runtime.InteropServices.ComVisible(false)]
public class ErrorSupport
[<System.Runtime.InteropServices.ComVisible(false)>]
type ErrorSupport = class
Public Class ErrorSupport
Inheritance
ErrorSupport
Derived
Attributes

Remarks

Although the data flow component developer can raise errors, warnings, and other events by calling the Fire<X> methods of the IDTSComponentMetaData100 interface, the Fire<X> methods of the ErrorSupport class provide additional value by retrieving descriptive messages that correspond to known COM HRESULTs returned by Integration Services components written in native code. Use the ErrorSupport property of the PipelineComponent base class to obtain an ErrorSupport object for this purpose.

Constructors

ErrorSupport(IDTSComponentEvents100)

Initializes a new instance of the ErrorSupport class.

ErrorSupport(IDTSComponentEvents100, String, String, Int32)

Initializes a new instance of the ErrorSupport class.

ErrorSupport(IDTSComponentMetaData100)

Initializes a new instance of the ErrorSupport class.

ErrorSupport(IDTSComponentMetaData100, String, String, Int32)

Initializes a new instance of the ErrorSupport class.

ErrorSupport(IDTSInfoEvents100)

Initializes a new instance of the ErrorSupport class.

ErrorSupport(IDTSInfoEvents100, String, String, Int32)

Initializes a new instance of the ErrorSupport class.

Methods

FireError(Int32, Boolean)

Raises an error identified by the specified HRESULT and allows execution to be cancelled.

FireError(Int32, String, String, Int32, Boolean)

Raises an error identified by the specified HRESULT, associates it with the specified component, help file, and help context, and allows execution to be cancelled.

FireErrorWithArgs(Int32, Boolean, Object[])

Raises an error identified by the specified HRESULT, allows execution to be cancelled, and includes an optional array of user-defined objects or information.

FireErrorWithArgs(Int32, String, String, Int32, Boolean, Object[])

Raises an error identified by the specified HRESULT, associates it with the specified component, help file, and help context, allows execution to be cancelled, and includes an optional array of user-defined objects or information.

FireInformation(Int32, Boolean)

Raises an informational message about the specified HRESULT and allows execution to be cancelled.

FireInformation(Int32, String, String, Int32, Boolean)

Raises an informational message about the specified HRESULT, associates it with the specified component, help file, and help context, and allows execution to be cancelled.

FireInformationWithArgs(Int32, Boolean, Object[])

Raises an informational message about the specified HRESULT, allows execution to be cancelled, and includes an optional array of user-defined objects or information.

FireInformationWithArgs(Int32, String, String, Int32, Boolean, Object[])

Raises an informational message about the specified HRESULT, associates it with the specified component, help file, and help context, allows execution to be cancelled, and includes an optional array of user-defined objects or information.

FireWarning(Int32)

Raises a warning identified by the specified HRESULT and allows execution to be cancelled.

FireWarning(Int32, String, String, Int32)

Raises a warning identified by the specified HRESULT and associates it with the specified component, help file, and help context.

FireWarningWithArgs(Int32, Object[])

Raises a warning identified by the specified HRESULT and includes an optional array of user-defined objects or information.

FireWarningWithArgs(Int32, String, String, Int32, Object[])

Raises a warning identified by the specified HRESULT, associates it with the specified component, help file, and help context, and includes an optional array of user-defined objects or information.

GetFormattedMessage(Int32, String, Object[])

Gets the error message for an HRESULT and formats the message by populating parameters with the supplied values.

GetFormattedMessageEx(Int32, String, Object[])

Gets the error message for an HRESULT and formats the message by populating parameters with the supplied values.

SetErrorInterface(IDTSComponentEvents100)

Specifies the IDTSComponentEvents100 instance that the ErrorSupport class will use to raise messages.

SetErrorInterface(IDTSComponentMetaData100)

Specifies the Microsoft.SqlServer.Dts.Pipeline.Wrapper.IDTSComponentMetadata100 instance that the ErrorSupport class will use to raise messages.

SetErrorInterface(IDTSInfoEvents100)

Specifies the IDTSInfoEvents100 instance that the ErrorSupport class will use to raise messages.

Applies to