ErrorSupport Class

Article
04/26/2013

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.

Inheritance Hierarchy

System.Object
Microsoft.SqlServer.Dts.ManagedMsg.ErrorSupport
Microsoft.SqlServer.Dts.ManagedMsg.DataflowErrorSupport

Namespace: Microsoft.SqlServer.Dts.ManagedMsg
Assembly: Microsoft.SqlServer.DtsMsg (in Microsoft.SqlServer.DtsMsg.dll)

Syntax

'Declaration
<ComVisibleAttribute(False)> _
Public Class ErrorSupport
'Usage
Dim instance As ErrorSupport

[ComVisibleAttribute(false)]
public class ErrorSupport

[ComVisibleAttribute(false)]
public ref class ErrorSupport

[<ComVisibleAttribute(false)>]
type ErrorSupport =  class end

public class ErrorSupport

The ErrorSupport type exposes the following members.

Constructors

	Name	Description
	ErrorSupport(IDTSComponentEvents100)	Initializes a new instance of the ErrorSupport class.
	ErrorSupport(IDTSComponentMetaData100)	Initializes a new instance of the ErrorSupport class.
	ErrorSupport(IDTSInfoEvents100)	Initializes a new instance of the ErrorSupport class.
	ErrorSupport(IDTSComponentEvents100, String, String, Int32)	Initializes a new instance of the ErrorSupport class.
	ErrorSupport(IDTSComponentMetaData100, String, String, Int32)	Initializes a new instance of the ErrorSupport class.
	ErrorSupport(IDTSInfoEvents100, String, String, Int32)	Initializes a new instance of the ErrorSupport class.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	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%, array<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%, array<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%, array<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%, array<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, array<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, array<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	Gets the error message for an HRESULT and formats the message by populating parameters with the supplied values.
	GetFormattedMessageEx	Gets the error message for an HRESULT and formats the message by populating parameters with the supplied values.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	SetErrorInterface(IDTSComponentEvents100)	Specifies the IDTSComponentEvents100 instance that the ErrorSupport class will use to raise messages.
	SetErrorInterface(IDTSComponentMetaData100)	Specifies the 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.
	ToString	(Inherited from Object.)

Top

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.

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.

Share via