Description

The Error method posts a new error message to the test log. An error message is a message next to which TestComplete displays the Error glyph.

Declaration

Log.Error(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

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

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 error 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.

If you don’t specify the Picture parameter or pass an empty value to it, the behavior of the method will depend on the Post image on error project property. If it is enabled, the method will log an image of the entire desktop. If the property is disabled, no image will be posted.

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 Error method will either post the message to the default folder of the test log or append the message 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 the PopLogFolder method correspondingly.

Result Value

None.

Remarks

If the Pause test execution on posting an error option is enabled, TestComplete activates the script debugger after the Error method is called. For more information, see Activating Debugger From Tests.

If the Log.CallStackSettings.EnableStackOnError property is True, then the test engine collects information about the execution sequence of tests that led to the call of the Log.Error 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.Error method, the test engine generates the OnLogError event.

Example

The code below specifies attributes for an error message and then posts this message to the test log.

JavaScript, JScript

function ErrorExample()
{
  var attr = Log.CreateNewAttributes;
  attr.ExtendedMessageAsPlainText = false;

  // Open a text file holding HTML code
  var MyFile = aqFile.OpenTextFile("C:\\MyHTMLCode.txt", aqFile.faRead, aqFile.ctANSI);

  // Read the HTML code from the file to a single string
  var str = MyFile.ReadAll();

  // Post a log message with the HTML page as extended information
  Log.Error("An error occurred", str, pmNormal, attr);
}

Python

def ErrorExample():
  attr = Log.CreateNewAttributes
  attr.ExtendedMessageAsPlainText = False
  # Open a text file holding HTML code
  MyFile = aqFile.OpenTextFile("C:\\MyFiles\\MyHTMLCode.txt", aqFile.faRead, aqFile.ctANSI)
  # Read the HTML code from the file to a single string
  str = MyFile.ReadAll()
  # Post a log message with the HTML page as extended information
  Log.Error("An error occurred", str, pmNormal, attr)

VBScript

Sub ErrorExample
  Dim attr, MyFile, str

  Set attr = Log.CreateNewAttributes
  attr.ExtendedMessageAsPlainText = False

  ' Open a text file holding HTML code
  Set MyFile = aqFile.OpenTextFile("c:\MyHTMLCode.txt", aqFile.faRead, aqFile.ctANSI)

  ' Read the HTML code from the file to a single string
  str = MyFile.ReadAll

  ' Post a log message with the HTML page as extended information
  Log.Error "An error occurred", str, pmNormal, attr
End Sub

DelphiScript

function ErrorExample;
var attr, MyFile, str;
begin
  attr := Log.CreateNewAttributes;
  attr.ExtendedMessageAsPlainText := false;

  // Open a text file holding HTML code
  MyFile := aqFile.OpenTextFile('C:\MyHTMLCode.txt', aqFile.faRead, aqFile.ctANSI);

  // Read the HTML code from the file to a single string
  str := MyFile.ReadAll;

  // Post a log message with the HTML page as extended information
  Log.Error('An error occurred', str, pmNormal, attr);
end;