destroy()
Destroy a PATROL object.
Syntax
destroy(object,[description])
Parameters
Parameter | Definition |
|---|---|
object | alphanumeric identifier for the object The object is assigned when the object is created. |
description | optional text string that can be used to explain why the object was destroyed The text string is recorded in the Description of the State Change Event in the Event Manager.Default |
Description
The destroy() function deletes the PATROL application instance object and returns TRUE on success and FALSE on error.
Example
The following example destroys an object represented by the variable name:
# destroy object whose name is in variable 'name'
destroy(name);
destroy(name);