IDTSEvents100.OnInformation Method

This API supports the SQL Server 2012 infrastructure and is not intended to be used directly from your code.

Called any time the task is required to provide information.

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

Syntax

'Declaration
Sub OnInformation ( _
    pSource As IDTSRuntimeObject100, _
    InformationCode As Integer, _
    SubComponent As String, _
    Description As String, _
    HelpFile As String, _
    HelpContext As Integer, _
    IDOfInterfaceWithError As String, _
    <OutAttribute> ByRef pbFireAgain As Boolean _
)
'Usage
Dim instance As IDTSEvents100 
Dim pSource As IDTSRuntimeObject100 
Dim InformationCode As Integer 
Dim SubComponent As String 
Dim Description As String 
Dim HelpFile As String 
Dim HelpContext As Integer 
Dim IDOfInterfaceWithError As String 
Dim pbFireAgain As Boolean

instance.OnInformation(pSource, InformationCode, _
    SubComponent, Description, HelpFile, _
    HelpContext, IDOfInterfaceWithError, _
    pbFireAgain)

void OnInformation(
    IDTSRuntimeObject100 pSource,
    int InformationCode,
    string SubComponent,
    string Description,
    string HelpFile,
    int HelpContext,
    string IDOfInterfaceWithError,
    out bool pbFireAgain
)

void OnInformation(
    [InAttribute] IDTSRuntimeObject100^ pSource, 
    [InAttribute] int InformationCode, 
    [InAttribute] String^ SubComponent, 
    [InAttribute] String^ Description, 
    [InAttribute] String^ HelpFile, 
    [InAttribute] int HelpContext, 
    [InAttribute] String^ IDOfInterfaceWithError, 
    [InAttribute] [OutAttribute] bool% pbFireAgain
)

abstract OnInformation : 
        pSource:IDTSRuntimeObject100 * 
        InformationCode:int * 
        SubComponent:string * 
        Description:string * 
        HelpFile:string * 
        HelpContext:int * 
        IDOfInterfaceWithError:string * 
        pbFireAgain:bool byref -> unit

function OnInformation(
    pSource : IDTSRuntimeObject100, 
    InformationCode : int, 
    SubComponent : String, 
    Description : String, 
    HelpFile : String, 
    HelpContext : int, 
    IDOfInterfaceWithError : String, 
    pbFireAgain : boolean
)

Parameters

• pSource
  Type: Microsoft.SqlServer.Dts.Runtime.Wrapper.IDTSRuntimeObject100
  The source of the error, the object that caused the event.

• InformationCode
  Type: System.Int32
  An Integer that identifies the message. This identifier should be unique when combined with the source parameter, so the source and informationCode combination should be unique. However, the informationCode alone is not expected to be unique.

• SubComponent
  Type: System.String
  An arbitrary string that identifies the sub-module within a source. For example, the transform in a Pipeline task.

• Description
  Type: System.String
  Text of the message.

• HelpFile
  Type: System.String
  The path to the help file containing detailed information.

• HelpContext
  Type: System.Int32
  Identifier of the topic in the Help file.

• IDOfInterfaceWithError
  Type: System.String
  A textual representation of the GUID of the interface that caused the error.

• pbFireAgain
  Type: System.Boolean%
  A Boolean that indicates this should continue firing or stop firing. A value of true indicates that it should continue firing.

Remarks

Compared to a warning, the informational event communicates important information that does not necessarily denote any data loss or other cause for concern. However, it is important enough that it warrants more than a log entry.

For more information, see IDTSEvents.

See Also

Reference

IDTSEvents100 Interface

Microsoft.SqlServer.Dts.Runtime.Wrapper Namespace