IDTSEvents.OnError Method

Called by a task or container when an error occurs.

Namespace: Microsoft.SqlServer.Dts.Runtime
Assembly: Microsoft.SqlServer.ManagedDTS (in microsoft.sqlserver.manageddts.dll)

bool OnError (
	DtsObject source,
	int errorCode,
	string subComponent,
	string description,
	string helpFile,
	int helpContext,
	string idofInterfaceWithError
)
boolean OnError (
	DtsObject source, 
	int errorCode, 
	String subComponent, 
	String description, 
	String helpFile, 
	int helpContext, 
	String idofInterfaceWithError
)
function OnError (
	source : DtsObject, 
	errorCode : int, 
	subComponent : String, 
	description : String, 
	helpFile : String, 
	helpContext : int, 
	idofInterfaceWithError : String
) : boolean

Parameters

source

The source of the error, the object that caused the event.

errorCode

An Integer that identifies the error message. This identifier should be unique when combined with the source parameter, so the source and errorCode combination should be unique. However, the errorCode alone is not expected to be unique.

subComponent

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

description

The text of the message.

helpFile

The path to the Help file that contains detailed information.

helpContext

Identifier of the topic in the Help file.

idofInterfaceWithError

A textual representation of the GUID of the interface that caused the error.

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

Community Additions

ADD
Show: