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