DefaultEvents.OnInformation Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
This event is raised anytime the task is to provide information.
public:
virtual void OnInformation(Microsoft::SqlServer::Dts::Runtime::DtsObject ^ source, int informationCode, System::String ^ subComponent, System::String ^ description, System::String ^ helpFile, int helpContext, System::String ^ idofInterfaceWithError, bool % fireAgain);public virtual void OnInformation (Microsoft.SqlServer.Dts.Runtime.DtsObject source, int informationCode, string subComponent, string description, string helpFile, int helpContext, string idofInterfaceWithError, ref bool fireAgain);abstract member OnInformation : Microsoft.SqlServer.Dts.Runtime.DtsObject * int * string * string * string * int * string * bool -> unit
override this.OnInformation : Microsoft.SqlServer.Dts.Runtime.DtsObject * int * string * string * string * int * string * bool -> unitPublic 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)Parameters
- source
- DtsObject
The object that caused the event.
- informationCode
- 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
- String
An arbitrary string that identifies the sub-module within a source. For example, the transform in a Pipeline task.
- description
- String
The text of the message.
- helpFile
- String
The path to the Help file that contains detailed information.
- helpContext
- Int32
Identifier of the topic in the Help file.
- idofInterfaceWithError
- String
A textual representation of the GUID of the interface that caused the error.
- fireAgain
- Boolean
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.
Implements
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.