OnLogCheckpoint Event

Applies to TestComplete 15.31, last modified on March 17, 2022

Occurs before a checkpoint message is posted to the test log.

Declaration

OnLogCheckpoint(SenderLogParams) Parameters
Sender [in] Required Variant
LogParams [in] Required A LogParams object

Description

The event occurs before a checkpoint message is posted to the test log. You can create the OnLogCheckpoint event handler to perform the desired actions upon posting checkpoint messages to the log. You can use the LogParams.MessageText and LogParams.AdditionalText properties to replace the TestComplete text with your own text.

Parameters

The event has the following parameters:

Sender

The Event control that processes the event.

LogParams

The properties of the LogParams object that holds the attributes of the posted message.

To avoid recurring calls, do not use the Log.Checkpoint method within the event handler of the OnLogCheckpoint event.

Remarks

For information on how to create an event handler for this and other TestComplete events, see Handling Events.

See Also

Posting Messages to the Log
LogParams Object
OnLogMessage Event
OnLogError Event
OnLogWarning Event
OnLogEvent Event
OnLogPicture Event
OnLogFile Event
OnLogLink Event
Handling Events
Event Control

Highlight search results