Share via

  • Article

IDTSEvents.OnInformation Method

Called any time the task is required to provide information.

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

Syntax

'Declaration
Sub OnInformation ( _
    source As DtsObject, _
    informationCode As Integer, _
    subComponent As String, _
    description As String, _
    helpFile As String, _
    helpContext As Integer, _
    idofInterfaceWithError As String, _
    ByRef fireAgain As Boolean _
)
'Usage
Dim instance As IDTSEvents
Dim source As DtsObject
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 fireAgain As Boolean

instance.OnInformation(source, informationCode, _
    subComponent, description, helpFile, _
    helpContext, idofInterfaceWithError, _
    fireAgain)

void OnInformation(
    DtsObject source,
    int informationCode,
    string subComponent,
    string description,
    string helpFile,
    int helpContext,
    string idofInterfaceWithError,
    ref bool fireAgain
)

void OnInformation(
    DtsObject^ source, 
    int informationCode, 
    String^ subComponent, 
    String^ description, 
    String^ helpFile, 
    int helpContext, 
    String^ idofInterfaceWithError, 
    bool% fireAgain
)

abstract OnInformation : 
        source:DtsObject * 
        informationCode:int * 
        subComponent:string * 
        description:string * 
        helpFile:string * 
        helpContext:int * 
        idofInterfaceWithError:string * 
        fireAgain:bool byref -> unit 

function OnInformation(
    source : DtsObject, 
    informationCode : int, 
    subComponent : String, 
    description : String, 
    helpFile : String, 
    helpContext : int, 
    idofInterfaceWithError : String, 
    fireAgain : boolean
)

Parameters

  • 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.
  • 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.
  • fireAgain
    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.