_SingleScript() Assure that only one script with the same name is running

[Exit 128]

_SingleScript UDF

Close all executing scripts with the same name and continue.
or
Wait for completion of predecessor scripts with the same name.
or
Exit if other scripts with the same name are executing.
or
Test, if other scripts with the same name are executing.

 

expandcollapse popup

#include-once
;==============================================================================================================
; UDF Name:         _SingleScript.au3
; Description:      iMode=0  Close all executing scripts with the same name and continue.
;                   iMode=1  Wait for completion of predecessor scripts with the same name.
;                   iMode=2  Exit if other scripts with the same name are executing.
;                   iMode=3  Test, if other scripts with the same name are executing.
;
; Syntax:           _SingleScript([iMode=0])
;                   Default:  iMode=0
; Parameter(s):     iMode:     0/1/2/3    see above
; Requirement(s):   none
; Return Value(s): -1= error      @error=-1   invalid iMode
;                   0= no other script executing @error=0 @extended=0
;                   1= other script executing @error=0 @extended=1 (only iMode=3)
; Example:
;               #include <_SingleScript.au3>  ; http://www.autoitscript.com/forum/index.php?showtopic=178681
;               _SingleScript() ; Close mode ( iMode defaults to 0 )
;               MsgBox(Default, Default, "No other script with name " & StringTrimRight(@ScriptName, 4) & " is executing.", 0)
;               ; see other example at end of this UDF
;
; Author:       Exit   ( http://www.autoitscript.com/forum/user/45639-exit )
; SourceCode:   http://www.autoitscript.com/forum/index.php?showtopic=178681   Version: 2020.02.04
; COPYLEFT:     © 2013 Freeware by "Exit"
;               ALL WRONGS RESERVED
;==============================================================================================================

Func _SingleScript($iMode = 0)
    Local $oWMI, $oProcess, $oProcesses, $aHandle, $aError
    Local $sPrefix = StringLeft(@ScriptName, StringInStr(@ScriptName, ".") - 1)
    Local $sMutexName = "_SingleScript " & $sPrefix
    If $iMode < 0 Or $iMode > 3 Then Return SetError(-1, -1, -1)
    If $iMode = 0 Or $iMode = 3 Then ; (iMode = 0) close all other scripts with the same name.  (iMode = 3) check, if others are running.
        $oWMI = ObjGet("winmgmts:\\" & @ComputerName & "\root\CIMV2")
        If @error Then
            RunWait(@ComSpec & ' /c net start winmgmt  ', '', @SW_HIDE)
            RunWait(@ComSpec & ' /c net continue winmgmt  ', '', @SW_HIDE)
            $oWMI = ObjGet("winmgmts:\\" & @ComputerName & "\root\CIMV2")
        EndIf
        $oProcesses = $oWMI.ExecQuery("SELECT * FROM Win32_Process", "WQL", 0x30)
        For $oProcess In $oProcesses
            If $oProcess.ProcessId = @AutoItPID Then ContinueLoop
            If ($oProcess.Name = "AutoIt3.exe" And StringInStr($oProcess.CommandLine, "AutoIt3Wrapper")) Then ContinueLoop
            If Not (StringInStr($oProcess.Name & $oProcess.CommandLine, $sPrefix)) Then ContinueLoop
            If $iMode = 3 Then Return SetError(0, 1, 1) ; indicate other script is running. Return value and @extended set to 1.
            If ProcessClose($oProcess.ProcessId) Then ContinueLoop
            MsgBox(262144, "Debug " & @ScriptName, "Error: " & @error & " Extended: " & @extended & @LF & "Processclose error: " & $oProcess.Name & @LF & "******", 0)
        Next
        Sleep(100) ; allow process to terminate
    EndIf
    $aHandle = DllCall("kernel32.dll", "handle", "CreateMutexW", "struct*", 0, "bool", 1, "wstr", $sMutexName) ; try to create Mutex
    $aError = DllCall("kernel32.dll", "dword", "GetLastError") ; retrieve last error
    If Not $aError[0] Then Return SetError(0, 0, 0)
    If $iMode = "2" Then Exit 1
    If $iMode = "0" Then Return SetError(1, 0, 1) ; should not occur
    DllCall("kernel32.dll", "dword", "WaitForSingleObject", "handle", $aHandle[0], "dword", -1) ; infinite wait for lock
    Return SetError(0, 0, 0)
EndFunc   ;==>_SingleScript

#comments-start     Here is the other example. Uncomment and use TIDY to reformat.
    #include <_SingleScript.au3>  ;http://www.autoitscript.com/forum/index.php?showtopic=178681
    If $cmdline[0] = 0 Then ; submit all scripts
    TraySetToolTip("No Case")
    _SingleScript() ; Kill other scripts, if others are executing
    For $i = 0 To 7
    Sleep(100)
    ShellExecute(@ScriptFullPath, $i)
    Next
    Exit MsgBox(64 + 262144, Default, "All scripts submitted. See icons in system tray. Case 1 already disappeared.", 0)
    EndIf
    TraySetToolTip("Case " & $cmdline[1])
    Switch $cmdline[1]
    Case 0
    $rc = _SingleScript(3) ; Check, if others are executing
    MsgBox(64 + 262144, Default, "Case " & $cmdline[1] & " executing. " & ($rc ? "Some" : "No") & " other scripts executing.", 0)
    Case 1
    _SingleScript(2) ; Kill this scropt, if others are executing
    Beep(440, 3000) ; you will NOT hear the long beep.
    Case 2, 3, 4, 6, 7
    _SingleScript(1) ; Wait for predecessors completed
    MsgBox(64 + 262144, Default, "Case " & $cmdline[1] & " executing.", 0)
    Case 5
    _SingleScript(1) ; Wait for predecessors completed (case 1-4)
    MsgBox(64 + 262144, Default, "Case " & $cmdline[1] & " executing." & @CRLF & "Now killing other scripts. See icons in system tray.", 0)
    _SingleScript() ; Now kill other scripts. Should be case 6 and 7
    _SingleScript(3) ; Check, if others are executing
    MsgBox(64 + 262144, Default, "Case " & $cmdline[1] & " executing. " & (@extended ? "Some" : "No") & " other scripts executing.", 0)
    EndSwitch
#comments-end       Here is the other example. Uncomment and use TIDY to reformat.

 

Edited February 4 by Exit
New Version: 2020.02.04

[guinness 1,510]

What if a user just renames the executable to get around the "one process rule"? I have code out there which takes this into account.

[JohnOne 1,603]

 

_SingleScript UDF

 

Close all executing scripts with the same name and continue.

or

Wait for completion of predecessor scripts with the same name.

or

Exit if other scripts with the same name are executing.

or

Test, if other scripts with the same name are executing.

Excellent.

[TheSaint 2,203]

Very good!

If I remember correctly, guinness also wrote some code, for when a program is already running, but minimized and forgotten, so that when you try to start it again, rather than create another instance or fail, it brings the first instance to the fore again.

I've also created code to have it query closure of the first instance instead of fail, and have the second instance as replacement.

Could be good to add them to your UDF, along with the internal ID to avoid the issue guinness mentioned.

[guinness 1,510]

If I remember correctly, guinness also wrote some code, for when a program is already running, but minimized and forgotten, so that when you try to start it again, rather than create another instance or fail, it brings the first instance to the fore again.

https://www.autoitscript.com/forum/topic/146672-_singletonhwid-enforce-a-design-paradigm-where-only-one-instance-of-the-script-may-be-running-with-using-a-unique-id-based-on-the-users-hardware/?page=3 (towards the end)

[TheDcoder 1,002]

COPYLEFT:     © 2013 Freeware by "Exit"
            ALL WRONGS RESERVED

[TheSaint 2,203]

As I was updating my code today for similar, as mentioned, I thought I would share it here.

[Exit 128]

Added a line in first Post

If ($oProcess.Name = "AutoIt3.exe" And StringInStr($oProcess.CommandLine, "AutoIt3Wrapper")) Then ContinueLoop

due to Autoit3wrapper changes.

[Exit 128]

New version: 2020.02.04

Source in first post.

Now also handling *.A3X and *.CMD files

For more information to A3X and CMD see the AU3toCmd in my signature

Edited February 4 by Exit