TSTool / Command / FreeObject

• Overview
• Command Editor
• Command Syntax
• Examples
• Troubleshooting
• See Also

---

Overview

The FreeObject command frees an object. The object will not be available for subsequent commands, although a new object with the same name can be created and used with subsequent commands. This command is useful, for example, when looping through blocks of commands where logic is repeated and the object contents are recreated.

Command Editor

The command is available in the following TSTool menu:

• Commands / Object Processing

The following dialog is used to edit the command and illustrates the command syntax.

FreeObject Command Editor (see also the full-size image)

Command Syntax

The command syntax is as follows:

FreeObject(Parameter="Value",...)

Command Parameters

Parameter	Description	Default
ObjectID required	The identifier for the object. Can be specified using ${Property} syntax.	None – must be specified.

Examples

See the automated tests.

Troubleshooting

See the main TSTool Troubleshooting documentation.

See Also

• NewObject command