Function Reference


SetExtended

Manually set the value of the @extended macro.

SetExtended ( code [, return value] )

Parameters

code The required value (integer) to set into the @extended macro.
return value [optional] The value to be returned by the function - if no parameter used the return value is undefined.

Return Value

Returns the "return value" parameter (undefined if the parameter is not used).
@extended will be set to the values set in the function call (default = 0)

Remarks

When entering a function @extended is set to 0. Unless SetExtended() is called, then @extended will remain 0 when the function ends. This means that in order for @extended to be set after a function returns, it must be explicitly set in the function. This also means you may need to backup the status of @extended in a variable if you are testing it in a While-WEnd loop.
The return value parameter is optional. It is provided as a way to use the Return SetExtended(...) syntax to define the value to be returned at the same time as setting @extended. If a specific value is not set then the return value will be undefined and should not be used subsequently by the code.

@extended is limited between the values of -2147483648 to 2147483647.

Related

SetError

Example

#include <MsgBoxConstants.au3>

SetExtended(10)
MsgBox($MB_SYSTEMMODAL, "", "Value of @extended is: " & @extended)