Share via

  • Article

IDTSComponentMetaData100.FireInformation Method

Raises an OnInformation event.

Namespace:  Microsoft.SqlServer.Dts.Pipeline.Wrapper
Assembly:  Microsoft.SqlServer.DTSPipelineWrap (in Microsoft.SqlServer.DTSPipelineWrap.dll)

Syntax

'Declaration
Sub FireInformation ( _
    InformationCode As Integer, _
    SubComponent As String, _
    Description As String, _
    HelpFile As String, _
    HelpContext As Integer, _
    <OutAttribute> ByRef pbFireAgain As Boolean _
)
'Usage
Dim instance As IDTSComponentMetaData100
Dim InformationCode As Integer
Dim SubComponent As String
Dim Description As String
Dim HelpFile As String
Dim HelpContext As Integer
Dim pbFireAgain As Boolean

instance.FireInformation(InformationCode, _
    SubComponent, Description, HelpFile, _
    HelpContext, pbFireAgain)

void FireInformation(
    int InformationCode,
    string SubComponent,
    string Description,
    string HelpFile,
    int HelpContext,
    out bool pbFireAgain
)

void FireInformation(
    [InAttribute] int InformationCode, 
    [InAttribute] String^ SubComponent, 
    [InAttribute] String^ Description, 
    [InAttribute] String^ HelpFile, 
    [InAttribute] int HelpContext, 
    [InAttribute] [OutAttribute] bool% pbFireAgain
)

abstract FireInformation : 
        InformationCode:int * 
        SubComponent:string * 
        Description:string * 
        HelpFile:string * 
        HelpContext:int * 
        pbFireAgain:bool byref -> unit 

function FireInformation(
    InformationCode : int, 
    SubComponent : String, 
    Description : String, 
    HelpFile : String, 
    HelpContext : int, 
    pbFireAgain : boolean
)

Parameters

  • InformationCode
    Type: System.Int32
    The component-defined information code.
  • SubComponent
    Type: System.String
    The name of the component that raises the event.
  • Description
    Type: System.String
    The description of the information event.
  • HelpFile
    Type: System.String
    The help file that provides more information about the error event.
  • HelpContext
    Type: System.Int32
    The context ID for the error.
  • pbFireAgain
    Type: System.Boolean%
    Specifies whether execution of the component is cancelled.

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.