Lock-UnLock VBAProjects Programmatically without SendKeys

[Jaafar Tribak]

Hi all,

I Have recently written this piece of code so I just thought I would post it here for future reference should anyone be looking for vba code to lock\unlock a vbaproject programmatically without needing to use the unreliable SendKeys method.

workbook example

This code requires that the excel macro security setting "Trust access to the vba project object model" be checked... .Also, it is worth mentioning that this code is language-specific as it reads the VBE dialog captions. So this code won't work in Non-English editions of excel but, should be easy to adapt with some small changes.

The code was written and tested in excel 2016-64bit.

Code goes in a Standard Module:

Option Explicit

#If VBA7 Then
    Private Declare PtrSafe Function SetWindowsHookEx Lib "user32" Alias "SetWindowsHookExA" (ByVal idHook As Long, ByVal lpfn As LongPtr, ByVal hmod As LongPtr, ByVal dwThreadId As Long) As LongPtr
    Private Declare PtrSafe Function UnhookWindowsHookEx Lib "user32" (ByVal hhk As LongPtr) As Long
    Private Declare PtrSafe Function CallNextHookEx Lib "user32" (ByVal hHook As LongPtr, ByVal nCode As Long, ByVal wParam As LongPtr, lParam As Any) As LongPtr
    Private Declare PtrSafe Function GetCurrentThreadId Lib "kernel32" () As Long
    Private Declare PtrSafe Function GetDlgItem Lib "user32" (ByVal hDlg As LongPtr, ByVal nIDDlgItem As Long) As LongPtr
    Private Declare PtrSafe Function GetActiveWindow Lib "user32" () As LongPtr
    Private Declare PtrSafe Function GetClassName Lib "user32" Alias "GetClassNameA" (ByVal hwnd As LongPtr, ByVal lpClassName As String, ByVal nMaxCount As Long) As Long
    Private Declare PtrSafe Function GetWindowText Lib "user32" Alias "GetWindowTextA" (ByVal hwnd As LongPtr, ByVal lpString As String, ByVal cch As Long) As Long
    Private Declare PtrSafe Function GetNextWindow Lib "user32" Alias "GetWindow" (ByVal hwnd As LongPtr, ByVal wFlag As Long) As LongPtr
    Private Declare PtrSafe Function FindWindowEx Lib "user32" Alias "FindWindowExA" (ByVal hWnd1 As LongPtr, ByVal hwnd2 As LongPtr, ByVal lpsz1 As String, ByVal lpsz2 As String) As LongPtr
    Private Declare PtrSafe Function SendMessage Lib "user32" Alias "SendMessageA" (ByVal hwnd As LongPtr, ByVal wMsg As Long, ByVal wParam As LongPtr, ByVal lParam As String) As LongPtr
    Private Declare PtrSafe Function SetFocus Lib "user32" (ByVal hwnd As LongPtr) As LongPtr
    Private Declare PtrSafe Function SetTimer Lib "user32" (ByVal hwnd As LongPtr, ByVal nIDEvent As LongPtr, ByVal uElapse As Long, ByVal lpTimerFunc As LongPtr) As LongPtr
    Private Declare PtrSafe Function KillTimer Lib "user32" (ByVal hwnd As LongPtr, ByVal nIDEvent As LongPtr) As Long
    Private Declare PtrSafe Function SetWindowPos Lib "user32" (ByVal hwnd As LongPtr, ByVal hWndInsertAfter As LongPtr, ByVal X As Long, ByVal Y As Long, ByVal cx As Long, ByVal cy As Long, ByVal wFlags As Long) As Long
    Private Declare PtrSafe Function SetActiveWindow Lib "user32" (ByVal hwnd As LongPtr) As LongPtr
    
    Private lHook As LongPtr
#Else
    
    Private Declare Function SetWindowsHookEx Lib "user32" Alias "SetWindowsHookExA" (ByVal idHook As Long, ByVal lpfn As Long, ByVal hmod As Long, ByVal dwThreadId As Long) As Long
    Private Declare Function UnhookWindowsHookEx Lib "user32" (ByVal hhk As Long) As Long
    Private Declare Function CallNextHookEx Lib "user32" (ByVal hHook As Long, ByVal nCode As Long, ByVal wParam As Long, lParam As Any) As Long
    Private Declare Function GetCurrentThreadId Lib "kernel32" () As Long
    Private Declare Function GetDlgItem Lib "user32" (ByVal hDlg As Long, ByVal nIDDlgItem As Long) As Long
    Private Declare Function GetActiveWindow Lib "user32" () As Long
    Private Declare Function GetClassName Lib "user32" Alias "GetClassNameA" (ByVal hwnd As Long, ByVal lpClassName As String, ByVal nMaxCount As Long) As Long
    Private Declare Function GetWindowText Lib "user32" Alias "GetWindowTextA" (ByVal hwnd As Long, ByVal lpString As String, ByVal cch As Long) As Long
    Private Declare Function GetNextWindow Lib "user32" Alias "GetWindow" (ByVal hwnd As Long, ByVal wFlag As Long) As Long
    Private Declare Function FindWindowEx Lib "user32" Alias "FindWindowExA" (ByVal hWnd1 As Long, ByVal hwnd2 As Long, ByVal lpsz1 As String, ByVal lpsz2 As String) As Long
    Private Declare Function SendMessage Lib "user32" Alias "SendMessageA" (ByVal hwnd As Long, ByVal wMsg As Long, ByVal wParam As Long, ByVal lParam As String) As Long
    Private Declare Function SetFocus Lib "user32" (ByVal hwnd As Long) As Long
    Private Declare Function SetTimer Lib "user32" (ByVal hwnd As Long, ByVal nIDEvent As Long, ByVal uElapse As Long, ByVal lpTimerFunc As Long) As Long
    Private Declare Function KillTimer Lib "user32" (ByVal hwnd As Long, ByVal nIDEvent As Long) As Long
    Private Declare Function SetWindowPos Lib "user32" (ByVal hwnd As Long, ByVal hWndInsertAfter As Long, ByVal X As Long, ByVal Y As Long, ByVal cx As Long, ByVal cy As Long, ByVal wFlags As Long) As Long
    Private Declare Function SetActiveWindow Lib "user32" (ByVal hwnd As Long) As Long
    
    Private lHook As Long
#End If

Private sWinClassName As String, sWorkbookName As String, sPassword As String



Public Property Let LockVBProject(ByVal WorkbookName As String, ByVal Password As String, ByVal bLock As Boolean)

    #If VBA7 Then
        Dim hwnd As LongPtr
    #Else
        Dim hwnd As Long
    #End If
    
    Const WH_CBT = 5

    On Error GoTo errHandler

    hwnd = GetActiveWindow
    
    With Application.VBE
        Set .ActiveVBProject = Application.Workbooks(WorkbookName).VBProject
        If bLock Then
            If .ActiveVBProject.Protection = 0 Then
                sWinClassName = "VBAProject - Project Properties"
                sWorkbookName = WorkbookName
            Else
                MsgBox "VBProect already locked": Exit Property
            End If
        Else
            If .ActiveVBProject.Protection Then
                sWinClassName = "VBAProject Password"
            Else
                MsgBox "VBProect already unlocked": Exit Property
            End If
        End If
    End With
    
    sPassword = Password
    lHook = SetWindowsHookEx(WH_CBT, AddressOf Catch_DlgBox_Activation, 0, GetCurrentThreadId)
    Application.VBE.CommandBars(1).FindControl(ID:=2578, recursive:=True).Execute
    
    If hwnd = Application.hwnd Then
        SetActiveWindow Application.hwnd
    End If
    
Exit Property

errHandler:
    Call UnHook
    MsgBox "Runtime Error : " & Err.Number & vbCr & vbCr & Err.Description, vbExclamation
    
End Property



#If VBA7 Then
    Private Function Catch_DlgBox_Activation(ByVal idHook As Long, ByVal wParam As LongPtr, ByVal lParam As LongPtr) As LongPtr
        Dim hwnd As LongPtr
#Else
    Private Function Catch_DlgBox_Activation(ByVal idHook As Long, ByVal wParam As Long, ByVal lParam As Long) As Long
        Dim hwnd As Long
#End If

    Const HCBT_ACTIVATE = 5
    Const SWP_HIDEWINDOW = &H80

    Dim sBuff As String * 256, lRet As Long
    
    If idHook = HCBT_ACTIVATE Then
    lRet = GetClassName(wParam, sBuff, 256)
    If Left(sBuff, lRet) = "#32770" Then
        sBuff = ""
        lRet = GetWindowText(wParam, sBuff, 256)
        If Left(sBuff, lRet) = sWinClassName Then
            Call UnHook
            SetWindowPos wParam, 0, 0, 0, 0, 0, SWP_HIDEWINDOW
            Call SetTimer(Application.hwnd, wParam, 0, AddressOf Protect_UnProtect_Routine)
        End If
    End If
    End If
    
    Catch_DlgBox_Activation = CallNextHookEx(lHook, idHook, ByVal wParam, ByVal lParam)
 
End Function


Private Sub UnHook()
    UnhookWindowsHookEx lHook
End Sub


#If VBA7 Then
Private Sub Protect_UnProtect_Routine(ByVal hwnd As LongPtr, ByVal uMsg As Long, ByVal nIDEvent As LongPtr, ByVal dwTimer As Long)
    Dim hCurrentDlg As LongPtr, hwndSysTab As LongPtr
#Else
Private Sub Protect_UnProtect_Routine(ByVal hwnd As Long, ByVal uMsg As Long, ByVal nIDEvent As Long, ByVal dwTimer As Long)
    Dim hCurrentDlg As Long, hwndSysTab As Long
#End If

    Const TCM_FIRST = &H1300
    Const TCM_SETCURSEL = (TCM_FIRST + 12)
    Const TCM_SETCURFOCUS = (TCM_FIRST + 48)
    Const EM_SETMODIFY = &HB9
    Const BM_SETCHECK = &HF1
    Const BST_CHECKED = &H1
    Const BM_GETCHECK = &HF0
    Const BM_CLICK = &HF5
    Const WM_SETTEXT = &HC
    Const WH_CBT = 5
    Const GW_CHILD = 5
    
    On Error GoTo errHandler
    
    Call KillTimer(Application.hwnd, nIDEvent)
    
    hCurrentDlg = nIDEvent
    
    If sWinClassName = "VBAProject - Project Properties" Then
    
        hwndSysTab = FindWindowEx(hCurrentDlg, 0, "SysTabControl32", vbNullString)
        Call SendMessage(hwndSysTab, TCM_SETCURFOCUS, 1, 0)
        Call SendMessage(hwndSysTab, TCM_SETCURSEL, 1, 0)
        
        If SendMessage(GetDlgItem(GetNextWindow(hCurrentDlg, GW_CHILD), &H1557), BM_GETCHECK, 0, 0) = 0 Then
            Call SendMessage(GetDlgItem(GetNextWindow(hCurrentDlg, GW_CHILD), &H1557), BM_SETCHECK, BST_CHECKED, 0)
            Call SendMessage(GetDlgItem(GetNextWindow(hCurrentDlg, GW_CHILD), &H1555), WM_SETTEXT, 0, sPassword)
            Call SendMessage(GetDlgItem(GetNextWindow(hCurrentDlg, GW_CHILD), &H1555), EM_SETMODIFY, True, 0)
            Call SendMessage(GetDlgItem(GetNextWindow(hCurrentDlg, GW_CHILD), &H1556), WM_SETTEXT, 0, sPassword)
            Call SendMessage(GetDlgItem(GetNextWindow(hCurrentDlg, GW_CHILD), &H1556), EM_SETMODIFY, True, 0)
        End If
        
        Call SendMessage(GetDlgItem(hCurrentDlg, &H1), BM_CLICK, 0, 0)
        Call Application.OnTime(Now, "SaveVBProjectChanges")
        
    ElseIf sWinClassName = "VBAProject Password" Then
    
        Call SendMessage(GetDlgItem(hCurrentDlg, &H155E), WM_SETTEXT, 0, sPassword)
        Call SendMessage(GetDlgItem(hCurrentDlg, &H155E), EM_SETMODIFY, True, 0)
        lHook = SetWindowsHookEx(WH_CBT, AddressOf Catch_DlgBox_Creation, 0, GetCurrentThreadId)
        Call SendMessage(GetDlgItem(hCurrentDlg, &H1), BM_CLICK, 0, 0)
        Call Application.OnTime(Now, "UnHook")
        
    End If
    
    Exit Sub
    
errHandler:
    Call UnHook
    MsgBox "Runtime Error : " & Err.Number & vbCr & vbCr & Err.Description, vbExclamation


End Sub


#If VBA7 Then
    Private Function Catch_DlgBox_Creation(ByVal idHook As Long, ByVal wParam As LongPtr, ByVal lParam As LongPtr) As LongPtr
#Else
    Private Function Catch_DlgBox_Creation(ByVal idHook As Long, ByVal wParam As Long, ByVal lParam As Long) As Long
#End If

    Const HCBT_CREATEWND = 3
    Dim sBuff As String * 256, lRet As Long
    
    If idHook = HCBT_CREATEWND Then
        lRet = GetClassName(wParam, sBuff, 256)
        If Left(sBuff, lRet) = "#32770" Then
            Catch_DlgBox_Creation = -1
            Exit Function
        End If
    End If
    
    Catch_DlgBox_Creation = CallNextHookEx(lHook, idHook, ByVal wParam, ByVal lParam)

End Function

Private Sub SaveVBProjectChanges()
    On Error Resume Next
    Application.EnableEvents = False
        Workbooks(sWorkbookName).Save
    Application.EnableEvents = True
End Sub

Code usage examples :

Sub Lock_Example()

    'To lock the vbproject. (change workbook name as required)
        LockVBProject(WorkbookName:="MyTestBook.xls", Password:="1234") = True

End Sub

Sub UnLock_Example()

    'To un-lock the vbproject. (change workbook name as required)
        LockVBProject(WorkbookName:="MyTestBook.xls", Password:="1234") = False

End Sub

 

[danitouffaha]

Hi Jaafar,

Thank you for the quick reply!!

I finally got it to work.

But I had to use a different approach, meaning the new file I am opening programmatically has to be opened in a new excel instance!

I was inspired by a thread I found on a different website, but I am not sure if I am allowed to post the link here or not, (please let me know so I can give the credit)

I had to tweak the code a little bit because initially it would open the properties and not close them

Anyway here is the code I ended up with


Notice I am passing the excel targetInstance because in the calling code, I decide if I should use my current instance or a new excel instance, and if it is a new one when I am done I close it!

Option Explicit

#If VBA7 Then

    Private Declare PtrSafe Function FindWindow Lib "user32" Alias "FindWindowA" (ByVal lpClassName As String, ByVal lpWindowName As String) As LongPtr

    Private Declare PtrSafe Function FindWindowEx Lib "user32" Alias "FindWindowExA" (ByVal hWnd1 As LongPtr, ByVal hwnd2 As LongPtr, ByVal lpsz1 As String, ByVal lpsz2 As String) As LongPtr

    Private Declare PtrSafe Function GetWindowText Lib "user32" Alias "GetWindowTextA" (ByVal hwnd As LongPtr, ByVal lpString As String, ByVal cch As Long) As Long

    Private Declare ptrsafe Function GetWindowTextLength Lib "user32" Alias "GetWindowTextLengthA" (ByVal hwnd As Long) As Longptr

    Private Declare PtrSafe Function SendMessage Lib "user32" Alias "SendMessageA" (ByVal hwnd As LongPtr, ByVal wMsg As Long, ByVal wParam As LongPtr, ByVal lParam As String) As LongPtr

#Else

    Private Declare Function FindWindow Lib "user32" Alias "FindWindowA" (ByVal lpClassName As String, ByVal lpWindowName As String) As Long

    Private Declare Function FindWindowEx Lib "user32" Alias "FindWindowExA" (ByVal hWnd1 As Long, ByVal hWnd2 As Long, ByVal lpsz1 As String, ByVal lpsz2 As String) As Long

    Private Declare Function GetWindowText Lib "user32" Alias "GetWindowTextA" (ByVal hwnd As Long, ByVal lpString As String, ByVal cch As Long) As Long

    Private Declare Function GetWindowTextLength Lib "user32" Alias "GetWindowTextLengthA" (ByVal hwnd As Long) As Long

    Private Declare Function SendMessage Lib "user32" Alias "SendMessageA" (ByVal hwnd As Long, ByVal wMsg As Long, ByVal wParam As Long, lParam As Any) As Long

#End If

 

Dim Ret As Long, ChildRet As Long, OpenRet As Long

Dim strBuff As String, ButCap As String

'Dim MyPassword As String


Public gforcedExit As Boolean

Private lastLockTime As Date


Const WM_SETTEXT = &HC

Const BM_CLICK = &HF5


Public Function unlockVBAProject(workbookPath As String, owb As Workbook, targetInstance As Object)

    Call logStartFunctionSub(False, False, "unlockVBAProject")

    If owb Is Nothing Then

        targetInstance.EnableEvents = False

        Set owb = targetInstance.Workbooks.Open(workbookPath)

    End If

    If isVBAProjectLocked(owb) = False Then

        Exit Function

    End If

    '~~> Launch the VBA Project Password window

    '~~> I am assuming that it is protected. If not then

    '~~> put a check here.

    targetInstance.VBE.CommandBars(1).FindControl(ID:=2578, recursive:=True).Execute

    '~~> Get the handle of the "VBAProject Password" Window

    Ret = FindWindow(vbNullString, "VBAProject Password")

    If Ret <> 0 Then

        'MsgBox "VBAProject Password Window Found"

      

        '~~> Get the handle of the TextBox Window where we need to type the password

        ChildRet = FindWindowEx(Ret, ByVal 0&, "Edit", vbNullString)

      

        If ChildRet <> 0 Then

            'MsgBox "TextBox's Window Found"

            '~~> This is where we send the password to the Text Window

            SendMess gadminPassword, ChildRet   'here put ur own PW

      

            DoEvents

      

            '~~> Get the handle of the Button's "Window"

            ChildRet = FindWindowEx(Ret, ByVal 0&, "Button", vbNullString)

          

            '~~> Check if we found it or not

            If ChildRet <> 0 Then

                'MsgBox "Button's Window Found"

  

                '~~> Get the caption of the child window

                strBuff = String(GetWindowTextLength(ChildRet) + 1, Chr$(0))

                GetWindowText ChildRet, strBuff, Len(strBuff)

                ButCap = strBuff

  

                '~~> Loop through all child windows

                Do While ChildRet <> 0

                    '~~> Check if the caption has the word "OK"

                    If InStr(1, ButCap, "OK") Then

                        '~~> If this is the button we are looking for then exit

                        OpenRet = ChildRet

                        Exit Do

                    End If

  

                    '~~> Get the handle of the next child window

                    ChildRet = FindWindowEx(Ret, ChildRet, "Button", vbNullString)

                    '~~> Get the caption of the child window

                    strBuff = String(GetWindowTextLength(ChildRet) + 1, Chr$(0))

                    GetWindowText ChildRet, strBuff, Len(strBuff)

                    ButCap = strBuff

                Loop

  

                '~~> Check if we found it or not

                If OpenRet <> 0 Then

                    '~~> Click the OK Button

                    SendMessage ChildRet, BM_CLICK, 0, vbNullString

                    Application.Wait DateAdd("s", 1, Now)

                  

                    Ret = FindWindow(vbNullString, "VBAProject - Project Properties")

                    ChildRet = FindWindowEx(Ret, ByVal 0&, "Button", vbNullString)

                    If ChildRet <> 0 Then

                        '~~> Get the caption of the child window

                        strBuff = String(GetWindowTextLength(ChildRet) + 1, Chr$(0))

                        GetWindowText ChildRet, strBuff, Len(strBuff)

                        ButCap = strBuff

          

                        '~~> Loop through all child windows

                        Do While ChildRet <> 0

                            '~~> Check if the caption has the word "OK"

                            If InStr(1, ButCap, "OK") Then

                                '~~> If this is the button we are looking for then exit

                                OpenRet = ChildRet

                                Exit Do

                            End If

          

                            '~~> Get the handle of the next child window

                            ChildRet = FindWindowEx(Ret, ChildRet, "Button", vbNullString)

                            '~~> Get the caption of the child window

                            strBuff = String(GetWindowTextLength(ChildRet) + 1, Chr$(0))

                            GetWindowText ChildRet, strBuff, Len(strBuff)

                            ButCap = strBuff

                        Loop

                        If OpenRet <> 0 Then

                            '~~> Click the OK Button

                            SendMessage ChildRet, BM_CLICK, 0, vbNullString

                        End If

                    End If

                Else

                    ecollectMessage = ecollectMessage & "-The OK Button handle was not found!" & newLine

                End If

            Else

                ecollectMessage = ecollectMessage & "-Button's Window Not Found!" & newLine

            End If

        Else

            ecollectMessage = ecollectMessage & "-The Edit Box was not found" & newLine

        End If

    Else

        ecollectMessage = ecollectMessage & "-VBAProject Password Window was not Found!" & newLine

    End If

End Function


Private Function SendMess(Message As String, hwnd As Long)

    Call SendMessage(hwnd, WM_SETTEXT, False, ByVal Message)

End Function


Public Function isVBAProjectLocked(aWorkbook As Workbook) As Boolean

    '1 = VB-Project protected

    '0 = VB-Project not protected

    isVBAProjectLocked = (aWorkbook.VBProject.Protection = 1)

End Function

Calling code, where I have a source workbook open and I open the locked target workbook, unlock, make code changes in it and then close it

    Dim wbTarget As Workbook

    Dim wbSource As Workbook

    Dim targetInstance As Object

    Dim sourceInstance As Object

......


            Set targetInstance = CreateObject("Excel.Application")

            Call unlockVBAProject(targetFileName, wbTarget, targetInstance) ' I pass the path to the workbook, an empty wbTarget, it will be set inside

            If isVBAProjectLocked(wbTarget) = True Then

                ecollectMessage = ecollectMessage & "-Failed to unprotect the Target project!" & vbaNewLine

                GoTo exitFunction

            End If


.....

    wbTarget.Close Savechanges:=True
     targetInstance.Quit
.....

Thanks again for your thread and sharing!!

Dani

 

[SkywardPalm]

The unlocking of the VBA doesn't seem to unlock it completely by unchecking the "Locked for Viewing" checkbox.. only allows you to read the code and it will still be locked the next time the file is opened. I have other macros that break when the code is locked, if there is any guidance towards this.