Export (0) Print
Expand All

IDTSComponentEvents.FireInformation Method

Raises an event containing information.

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

void FireInformation(
	int informationCode,
	string subComponent,
	string description,
	string helpFile,
	int helpContext,
	ref bool fireAgain
)

Parameters

informationCode
Type: Int32
An Integer that identifies the informational message.
subComponent
Type: String
A String that contains more detail about the event source.
description
Type: String
The text of the message.
helpFile
Type: String
The path to the Help file that contains detailed information.
helpContext
Type: Int32
The identifier of the topic in the Help file.
fireAgain
Type: Boolean
A Boolean that indicates this should continue firing or stop firing. A value of true indicates that it should continue firing.

The definition of an information event is that it is a message important enough to always be displayed to most users. It differs from a warning in that no potential damage is implied, and it differs from logging in that it cannot be turned off or filtered and in that it can be handled by event handler.

Because firing of an event may be expensive, the run-time engine provides a mechanism for suppressing events that you are not interested in. Every event firing method has a FireAgain parameter. If the value of this variable is false, after the method returns, the caller will not fire this event again for the duration of the current execution.

Several of the events have a subComponent parameter that allows for even greater granularity in event source identification.

Community Additions

ADD
Show:
© 2014 Microsoft