IDTSComponentMetaData90.FireInformation Method

Article
12/03/2008

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

Syntax

'Declaration
<DispIdAttribute(128)> _
Sub FireInformation ( _
    <InAttribute> InformationCode As Integer, _
    <InAttribute> SubComponent As String, _
    <InAttribute> Description As String, _
    <InAttribute> HelpFile As String, _
    <InAttribute> HelpContext As Integer, _
    <InAttribute> <OutAttribute> ByRef pbFireAgain As Boolean _
)

[DispIdAttribute(128)] 
void FireInformation (
    [InAttribute] int InformationCode,
    [InAttribute] string SubComponent,
    [InAttribute] string Description,
    [InAttribute] string HelpFile,
    [InAttribute] int HelpContext,
    [InAttribute] out bool pbFireAgain
)

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

/** @attribute DispIdAttribute(128) */ 
void FireInformation (
    /** @attribute InAttribute() */ int InformationCode, 
    /** @attribute InAttribute() */ String SubComponent, 
    /** @attribute InAttribute() */ String Description, 
    /** @attribute InAttribute() */ String HelpFile, 
    /** @attribute InAttribute() */ int HelpContext, 
    /** @attribute InAttribute() */ /** @attribute OutAttribute() */ /** @ref */ boolean pbFireAgain
)

JScript does not support passing value-type arguments by reference.

Parameters

InformationCode
The component-defined information code.

SubComponent
The name of the component that raises the event.

Description
The description of the information event.

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

HelpContext
The context ID for the error.

pbFireAgain
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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Share via