IDTSComponentMetaData100.FireInformation Method

  • Reference

Definition

Namespace:
Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly:
Microsoft.SqlServer.DTSPipelineWrap.dll

Raises an OnInformation(IDTSRuntimeObject100, Int32, String, String, String, Int32, String, Boolean) event.

public:
 void FireInformation(int InformationCode, System::String ^ SubComponent, System::String ^ Description, System::String ^ HelpFile, int HelpContext, [Runtime::InteropServices::Out] bool % pbFireAgain);
[System.Runtime.InteropServices.DispId(128)]
public void FireInformation (int InformationCode, string SubComponent, string Description, string HelpFile, int HelpContext, out bool pbFireAgain);
[<System.Runtime.InteropServices.DispId(128)>]
abstract member FireInformation : int * string * string * string * int * bool -> unit
Public Sub FireInformation (InformationCode As Integer, SubComponent As String, Description As String, HelpFile As String, HelpContext As Integer, ByRef pbFireAgain As Boolean)

Parameters

InformationCode
Int32

The component-defined information code.

SubComponent
String

The name of the component that raises the event.

Description
String

The description of the information event.

HelpFile
String

The help file that provides more information about the information event.

HelpContext
Int32

The context ID for the information.

pbFireAgain
Boolean

Specifies whether the event should be raised again in the future.

Attributes
DispIdAttribute

Remarks

The OnInformation event should only be raised during component execution since the information is not visibly captured during component design.

The pbFireAgain parameter is set by the runtime and indicates whether any clients are listening to the event. Components store the value of this parameter locally and should evaluate its value before raising the event again. If the value of the pbFireAgain parameter is false, the event should not be raised.

Applies to