Float_setValue

 Homepage
Wrappers

Sets the value stored in the Float object.

Float_setValue(FloatObject, value = 0)

Parameters

FloatObject The Float object to use for the current operation.
value The value to store in the Float object.

Return Value

The previous value stored in FloatObject.

Remarks

If FloatObject is NULL (0 or blank), the empty string is returned, to indicate an error.

Related

Float_getValue

Float

Examples

;Creates a new Float initialized to 42
myFloat := Float_new(42)

;Sets myFloat to 13 (and returns the old value)
oldValue := Float_setValue(myFloat, 13)

;Outputs oldValue and the value stored in myFloat
MsgBox, % "The previous value for myFloat was: " oldValue . "`n"
        . "The current value for myFloat is: " Float_getValue(myFloat)

Homepage  |  Wrappers