DefaultEvents.OnInformation Method

Article
12/03/2008

This event is raised anytime the task is to provide information.

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

Syntax

'Declaration
Public Overridable 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 _
)

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

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

public void OnInformation (
    DtsObject source, 
    int informationCode, 
    String subComponent, 
    String description, 
    String helpFile, 
    int helpContext, 
    String idofInterfaceWithError, 
    /** @ref */ boolean fireAgain
)

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

Parameters

source
The object that caused the event.

informationCode
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
An arbitrary string that identifies the sub-module within a source. For example, the transform in a Pipeline task.

description
The text of the message.

helpFile
The path to the Help file that contains detailed information.

helpContext
Identifier of the topic in the Help file.

idofInterfaceWithError
A textual representation of the GUID of the interface that caused the error.

fireAgain
A Boolean that indicates if the client wants to receive this message. The client must set this to true if they want to receive this event again in the future.

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.

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