Destroys the Char object and frees its memory.
Result := Char_destroy(CharObject)
Parameters
| CharObject |
The Char object to use for the current operation. |
Return Value
True (1) if the Char was actually
destroyed,
or False (0) if the Char was not destroyed (see 1 below).
Remarks
The object will not be destroyed
if:
- The lock count for
CharObject is more than one. In this case, the lock count for CharObject
will be decreased by one, and the function returns false to indicate that
the object still exists.
- CharObject is NULL (0 or blank) - returns the empty string to indicate
an error.
Related
Char_new
Char
Examples
;Creates a new Char initialized to 42
myChar := Char_new(42)
;Destroys myChar and frees its memory
Result := Char_destroy(myChar)
Homepage | Wrappers