Function Reference


Registers an Adlib function.

AdlibRegister ( "function" [, time = 250] )


function The name of the adlib function to be registered.
time [optional] how often in milliseconds to call the function. Default is 250 ms.

Return Value

Success: 1.
Failure: 0.


Every 250 ms (or time ms) the specified "function" is called--typically to check for unforeseen errors. For example, you could use adlib in a script which causes an error window to pop up unpredictably.
The adlib function should be kept simple as it is executed often and during this time the main script is paused. Also, the time parameter should be used carefully to avoid CPU load.
You can not register a function using parameters.

Several Adlib functions can be registered. Re-registering an already existing Adlib function will update it with a new time.




#include <MsgBoxConstants.au3>

If ProcessExists("SciTE.exe") = 0 Then
    MsgBox($MB_SYSTEMMODAL, "", "You will need SciTE.exe to be running for ConsoleWrite to display.")


Func Example()
    ; Register the function MyAdLibFunc() to be called every 250ms (default).

    ; Sleep does not stop AdLib functions from running.

    ; AdLib functions don't run while a blocking function is shown e.g. MsgBox, InputBox, WinWait, WinWaitClose etc.
    MsgBox($MB_SYSTEMMODAL, "", "No console message(s) will be shown whilst the messagebox is displayed.")

    ; The AdLib function MyAdLibFunc() will start again.

    ; Unregister the function MyAdLibFunc() from being called every 250ms.
EndFunc   ;==>Example

Func MyAdLibFunc()
    ; Assign a static variable to hold the number of times the function is called.
    Local Static $iCount = 0
    $iCount += 1

    ConsoleWrite("MyAdLibFunc called " & $iCount & " time(s)" & @CRLF)
EndFunc   ;==>MyAdLibFunc