Function Reference


Sends a message to a Dummy control.

GUICtrlSendToDummy ( controlID [, state] )


controlID The control identifier (controlID) as returned by GUICtrlCreateDummy()
state [optional] value that can be retrieved later on by GUICtrlRead()

Return Value

Success: 1.
Failure: 0.


When this function is called a notification that can be handled through the message loop or with a GUICtrlSetOnEvent() function is generated (as if the control had been "clicked" on).

Note that the function will not action the dummy control if the GUI in which it was created is hidden, as by design none of the controls on such a GUI can be actioned.

If the "state" sent to the dummy control is a numeric value, it is limited to a 32bit(4bytes) signed integer - only the lower 4 bytes of higher values will be sent.


GUICtrlCreateDummy, GUICtrlRead, GUICtrlSetOnEvent


#include <GUIConstantsEx.au3>

Global $g_idUserDummy, $g_iState = 0


Func Example()
        Opt("GUIOnEventMode", 1) ; Set the option to use GUIOnEventMode.

        GUICreate("GUISendToDummy", 220, 200, 100, 200)
        GUISetBkColor(0x00E0FFFF) ; Change the background color of the GUI.
        GUISetOnEvent($GUI_EVENT_CLOSE, "OnExit") ; Set an event to call the 'OnExit' function.

        $g_idUserDummy = GUICtrlCreateDummy()
        GUICtrlSetOnEvent(-1, "OnDummy") ; Set an event to call the 'OnExit' function when this control is selected.

        GUICtrlCreateButton("Click", 70, 170, 85, 25)
        GUICtrlSetOnEvent(-1, "OnClick") ; Set an event to call the 'OnClick' function when this control is selected.

        GUICtrlSendToDummy($g_idUserDummy, 1) ; Set state to be checked Onclick

        ; Display the GUI.
        ; Loop until the user exits.
        While 1
EndFunc   ;==>Example

Func OnClick()
        Return GUICtrlSendToDummy($g_idUserDummy) ; Send a message to the dummy control that the close button was selected, which will then proceed to call the function 'OnExit'.
EndFunc   ;==>OnClick

Func OnDummy()
        If GUICtrlRead($g_idUserDummy) Then
                GUISetBkColor(0x000000FF) ; Change the background color of the GUI on dummy state
EndFunc   ;==>OnDummy

Func OnExit()
        Exit ; Exit the script.
EndFunc   ;==>OnExit