OnInformation Method

DefaultEvents.OnInformation Method (DtsObject, Int32, String, String, String, Int32, String, Boolean)

 

This event is raised anytime the task is to provide information.

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

public virtual void OnInformation(
	DtsObject source,
	int informationCode,
	string subComponent,
	string description,
	string helpFile,
	int helpContext,
	string idofInterfaceWithError,
	ref bool fireAgain
)

Parameters

source
Type: Microsoft.SqlServer.Dts.Runtime.DtsObject

The object that caused the event.

informationCode
Type: System.Int32

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

subComponent
Type: System.String

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

description
Type: System.String

The text of the message.

helpFile
Type: System.String

The path to the Help file that contains detailed information.

helpContext
Type: System.Int32

Identifier of the topic in the Help file.

idofInterfaceWithError
Type: System.String

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

fireAgain
Type: System.Boolean

A Boolean that indicates if the client wants to receive this message. The client must set this to true if they want to receive this event again in the future.

Compared to a warning, the informational event communicates important information that does not necessarily denote any data loss or other cause for concern. However, it is important enough that it warrants more than a log entry.

Return to top
Show:
© 2016 Microsoft