IDTSEvents100.OnInformation Method (IDTSRuntimeObject100, Int32, String, String, String, Int32, String, Boolean)

 

This API supports the product 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)

[DispIdAttribute(5)]
void OnInformation(
	IDTSRuntimeObject100 pSource,
	int InformationCode,
	string SubComponent,
	string Description,
	string HelpFile,
	int HelpContext,
	string IDOfInterfaceWithError,
	ref bool pbFireAgain
)

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.

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.

Return to top
Show: