Description

The Checkpoint method posts a new message of the checkpoint type to the test log. A checkpoint message is a message next to which TestComplete displays the Checkpoint glyph.

Declaration

Log.Checkpoint(MessageText, AdditionalInformation, Priority, Attr, Picture, FolderID)

MessageText	[in]	Required	Variant
AdditionalInformation	[in]	Optional	Variant	Default value: Empty string
Priority	[in]	Optional	Integer	Default value: pmNormal
Attr	[in]	Optional	A `LogAttributes` object	Default value: Default attributes
Picture	[in]	Optional	A string, a `Picture` object or an object that has the `Picture` method which returns a `Picture` object
FolderID	[in]	Optional	Integer	Default value: -1
Result	None

Applies To

The method is applied to the following object:

Log

Parameters

The method has the following parameters:

MessageText

The message text. This text will be added to the Message column of the Test Log. MessageText can hold data of any OLE-compatible type. If it cannot be converted to text, its value is ignored.

The parameter does not support multiline text, that is, you cannot post multiline messages to the Message column. To post multiline text to your test log, use the AdditionalInformation parameter.

AdditionalInformation

Additional text to be displayed in the Details pane of the Test Log. AdditionalInformation can hold data of any type compatible with OLE. If it cannot be converted to text, its value is ignored.

The AdditionalInformation parameter can also hold HTML code. The test engine will compile the HTML page and display it in the Details pane. For more information, see Posting Messages to the Log.

Priority

The message priority. You can use any integer number or any of the following constants:

Constant	Value	Description
`pmLowest`	100	The lowest priority of the message.
`pmLower`	200	The message priority which is lower than normal.
`pmNormal`	300	The normal (default) priority of the message.
`pmHigher`	400	The message priority which is higher than normal.
`pmHighest`	500	The highest priority of the message.

Attr

The font and color settings that will be applied to the newly created informative message in the log. They are represented by a LogAttributes object. If this parameter is omitted, default attributes will be applied.

Picture

Specifies the image to be posted to the test log along with the message. This image will be displayed in the Picture pane of the Test Log when that message is selected. You can use one of the following values in this parameter:

A Picture object.
A window or onscreen object or the Desktop object.
The fully-qualified path to the image file. The following image formats are supported:
- BMP
- JPEG
- PNG
- TIFF
- GIF
- ICO

The format of the posted images specified by the mentioned scripting objects is controlled by the image settings of your test project. The format of images taken from existing files is not changed.

FolderID

Identifier of the test log’s folder to which the message will be posted. To get this identifier, use the CreateFolder or AppendFolder method. If this parameter refers to a non-existent folder, is omitted or is set to -1 (the default value), the Message method will either post the message to the default folder of the test log or append it to the test log outside of any folder (if the default folder is not set). The default folder is the folder that is currently at the top of the folder stack, which is populated during the script run. To push a folder to or pop it out of this stack, use the PushLogFolder or PopLogFolder method correspondingly.

Result Value

None.

Remarks

If the Log.CallStackSettings.EnableStackOnMessage property is True, then the test engine collects information about the execution sequence of tests that led to the call of the Log.Checkpoint method and displays this information in the Call Stack page of the test log. See Collecting Call Stack Information for Log Messages.

When you call the Log.Checkpoint method, the test engine generates the OnLogCheckpoint event.

Example

The following code illustrates the use of the Log.Checkpoint method:

JavaScript, JScript

function Test()
{
if (Regions.Compare("Image1Name", "Image2Name"))
Log.Checkpoint("The verification passed.");
}

Python

def Test():
  if Regions.Compare("Image1Name", "Image2Name"):
    Log.Checkpoint("The verification passed.")

VBScript

Sub Test
  If Regions.Compare("Image1Name", "Image2Name") Then
    Log.Checkpoint "The verification passed."
  End If
End Sub

DelphiScript

procedure Test;
begin
if Regions.Compare('Image1Name', 'Image2Name') then
Log.Checkpoint('The verification passed.');
end;

C++Script, C#Script

function Test()
{
if (Regions["Compare"]("Image1Name", "Image2Name"))
Log["Checkpoint"]("The verification passed.");
}

After these tests have been run, the log will contain the The verification passed string with the icon in the Type column.

Log.Checkpoint Method