IDTSComponentEvents.FireInformation(Int32, String, String, String, Int32, Boolean) IDTSComponentEvents.FireInformation(Int32, String, String, String, Int32, Boolean) IDTSComponentEvents.FireInformation(Int32, String, String, String, Int32, Boolean) Method

Definition

Raises an event containing information.

public:
 void FireInformation(int informationCode, System::String ^ subComponent, System::String ^ description, System::String ^ helpFile, int helpContext, bool % fireAgain);
public void FireInformation (int informationCode, string subComponent, string description, string helpFile, int helpContext, ref bool fireAgain);
Public Sub FireInformation (informationCode As Integer, subComponent As String, description As String, helpFile As String, helpContext As Integer, ByRef fireAgain As Boolean)
Parameters
informationCode
Int32 Int32 Int32

An Integer that identifies the informational message.

subComponent
String String String

A String that contains more detail about the event source.

description
String String String

The text of the message.

helpFile
String String String

The path to the Help file that contains detailed information.

helpContext
Int32 Int32 Int32

The identifier of the topic in the Help file.

fireAgain
Boolean Boolean Boolean

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

Remarks

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.

Applies to