List of Built-In Routines

Applies to TestComplete 15.63, last modified on April 10, 2024

The following list contains the functions provided by the BuiltIn plugin. The plugin is installed and enabled by default. The functions below are available to all script languages.

Functions, variables and constants provided by the plugin are displayed in the Code Completion window as subitems of the BuiltIn item (except for those functions that are mentioned as obsolete in the table below). You can also call them in Connected or Self-Testing Applications as methods of the BuiltIn object.

You can skip the object name (BuiltIn) when calling these methods in TestComplete scripts. However, if the method name coincides with the name of a function provided by the scripting language, TestComplete will call the scripting languageā€™s function. To solve the problem, place the object name before the method name. See Specifics of Usage Common for All Languages.

Most of the functions listed below are obsolete. They are supported only for backward compatibility and not displayed in the Code Completion window. We recommend that you replace obsolete functions in your existing tests with similar functions provided by the aqConvert, aqFile, aqObject and other aqNNN objects and use these new functions in your future tests.

Routine List

Name Description
CallMethod Obsolete. Calls a method of the specified object. Use the aqObject.CallMethod method instead.
CopyFiles Obsolete. Copies a file or folder to a new location.To copy files, use the aqFileSystem.CopyFile, aqFile.Copy or aqFileInfo.Copy method. To copy folders, use the aqFileSystem.CopyFolder or aqFolderInfo.Copy method.
CreateVariantArray Creates an array of Variant elements.
CreateVariantArray2 Creates a two-dimensional array of Variant elements.
CreateVariantArray3 Creates a three-dimensional array of Variant elements.
Delay Obsolete. Delays the script execution for the specified time period. Use the aqUtils.Delay method instead.
EnumEvents Obsolete. Returns an ObjEventIterator object that provides scripting access to the list of object events. Use the aqObject.GetEvents method instead.
EnumFields Obsolete. Returns an ObjFieldIterator object that provides scripting access to the list of object fields. Use the aqObject.GetFields method instead.
EnumMethods Obsolete. Returns an ObjMethodIterator object that provides scripting access to the list of object methods. Use the aqObject.GetMethods method instead.
EnumProperties Obsolete. Returns an ObjPropertyIterator object that provides scripting access to the list of object properties. Use the aqObject.GetProperties method instead.
GetCOMServerPath Obsolete. Returns the path to the specified COM server. Use the aqUtils.GetCOMServerPath method instead.
GetCSVCount Obsolete. Returns the number of values in a comma-separated string. Use the aqString.GetListLength method instead.
GetCSVItem Obsolete. Returns a value by its index in a comma-separated string. Use the aqString.GetListItem method instead.
GetListCount Obsolete. Returns the number of list values separated by line breaks and carriage returns. Use the aqString.GetListLength method instead.
GetListItem Obsolete. Returns a value by its index in a list whose values are separated by line breaks and carriage returns. Use the aqString.GetListItem method instead.
GetOrd Returns the ordinal value of an ordinal-type expression.
GetValue Obsolete. Returns the value of the specified object property. Use the aqObject.GetPropertyValue method instead.
InputBox Displays a window that lets the user specify a value that can be used in script.
InputQuery Displays a window that lets the user specify a value that can be used in script. It is supported for VBScript and DelphiScript only.
IsLanguageSupported Obsolete. Checks whether the specified language is supported on the computer. Use the aqEnvironment.IsLanguageSupported method instead.
IsPluginInstalled Obsolete. Checks whether the specified plugin is installed and enabled in TestComplete. Use the aqEnvironment.IsPluginInstalled method instead.
IsSupported Obsolete. Checks whether an object supports the specified property or method. Use the aqObject.IsSupported method instead.
Log Returns the natural logarithm of a number.
MessageDlg Displays a dialog box.
ParamCount Returns a number of command-line arguments passed to TestComplete at startup.
ParamStr Returns a TestComplete command-line argument specified by its index.
RaiseEvent Obsolete. Generates an event of the specified object. Use the aqObject.RaiseEvent method instead.
RebootAndContinue Obsolete. Reboots the operating system and continues the test execution after the restart. Use the aqEnvironment.RebootAndContinue method instead.
RemoveFolders Obsolete. Deletes a folder from the disk. Use the aqFileSystem.DeleteFolder method instead.
SaveStrToFile Obsolete. Saves a string to a file. Use the aqFile.WriteToTextFile or aqFileInfo.WriteToTextFile method instead.
SendMail Sends an e-mail message using the Simple Mail Transfer Protocol (SMTP).
SendMAPIMail Obsolete. Sends an e-mail message using the Messaging Application Programming Interface (MAPI). Use the BuiltIn.SendMail method instead.
SetKeyboardLayout Obsolete. Changes the current keyboard layout. Use the aqEnvironment.SetKeyboardLayout method instead.
SetValue Obsolete. Sets a value for the specified object property. Use the aqObject.SetPropertyValue method instead.
ShowMessage Displays a message box.
StrContains Obsolete. Checks whether a string contains a specific substring. Use the aqString.Find method instead.
StrEndsWith Obsolete. Checks whether a string ends with the specified substring. To work with strings in tests, use the methods of the aqString object.
StrMatches Obsolete. Checks whether a string contains a fragment that matches the specified regular expression. Use the aqString.StrMatches method instead.
StrStartsWith Obsolete. Checks whether a string begins with the specified substring. To work with strings in tests, use the methods of the aqString object instead.
VarArrayHighBound Returns the high bound of the specified dimension of a Variant array.
VarArrayLowBound Returns the low bound of the specified dimension of a Variant array.
VarArrayRedim Resizes a Variant array. It is supported for VBScript and DelphiScript.
VarClear Sets the OLEVariant value to empty.
VarToBool Obsolete. Converts an OLEVariant value to a Boolean value. Use the aqConvert.VarToBool method instead.
VarToFloat Obsolete. Converts an OLEVariant value to a float value. Use the aqConvert.VarToFloat method instead.
VarToInteger Obsolete. Converts an OLEVariant value to an integer value. Use the aqConvert.VarToInt method instead.
VarToStr Obsolete. Converts an OLEVariant value to a string value. Use the aqConvert.VarToStr method instead.
VarToString Obsolete. Converts an OLEVariant value to a string value. Use the aqConvert.VarToStr method instead.
VarToWString Obsolete. Converts an OLEVariant value to a wide-string value. Use the aqConvert.VarToStr method instead.
VarType Obsolete. Returns the type of the specified value. Use the aqObject.GetVarType method instead.

See Also

DelphiScript - List of Supported Routines and Variables
TestComplete Helper Objects
Installing Extensions
Utilities Object
ADO Support Plugin
Calling Win32 API Functions

Highlight search results