IDTSInfoEvents.FireError(Int32, String, String, String, Int32) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dts.Runtime

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

Fires an error.

public:
 bool FireError(int errorCode, System::String ^ subComponent, System::String ^ description, System::String ^ helpFile, int helpContext);

public bool FireError (int errorCode, string subComponent, string description, string helpFile, int helpContext);

abstract member FireError : int * string * string * string * int -> bool

Public Function FireError (errorCode As Integer, subComponent As String, description As String, helpFile As String, helpContext As Integer) As Boolean

Parameters

errorCode: Int32

An Integer that identifies the error message.

subComponent: String

An arbitrary string that identifies the sub-module within a source. For example, the transform in a Pipeline task.

description: String

Text of the message.

helpFile: String

The path to the Help file that contains detailed information.

helpContext: Int32

Identifier of the topic in the Help file.

Returns

Boolean

A Boolean that indicates if this should continue firing or stop firing. A value of true indicates that it should continue firing.

Remarks

Provides information about a failure.

Applies to