Check if file is locked or not and present to end user if it is locke…

…d and by what. Resulted in breaking some of my habits and putting a messagebox windows in libraries. Not my favorite thing, but it works. This helps debug issue 3, it does not resolve issue 3. To test it - open an office document (such as Word or Excel) and try to overwrite the office document with the RDP file including the office document extention (xls, xlsx, doc, docx, etc). The application will tell you that the file is locked, locked by Word/Excel/etc and the PID that is locking it just in case you have multiple copies of the application that is locking it open. A lot of the code was borrowed from Microsoft (https://code.msdn.microsoft.com/windowsapps/How-to-know-the-process-170ed5f3/sourcecode?fileId=151114&pathId=1558127374).
MrBrianGale · Nov 15, 2019 · 57111a3 · 57111a3
1 parent f7a343e
commit 57111a3
Show file tree

Hide file tree

Showing 19 changed files with 808 additions and 15 deletions.
diff --git a/LockChecker/LockCheck.vb b/LockChecker/LockCheck.vb
@@ -0,0 +1,233 @@
+' code sample taken from:
+'https://code.msdn.microsoft.com/windowsapps/How-to-know-the-process-170ed5f3/sourcecode?fileId=151114&pathId=1558127374
+' Modified to suit the needs of this application
+Imports System.ComponentModel
+Imports System.Runtime.InteropServices
+
+Module LockCheck
+    ' maximum character count of application friendly name. 
+    Private Const CCH_RM_MAX_APP_NAME As Integer = 255
+    ' maximum character count of service short name. 
+    Private Const CCH_RM_MAX_SVC_NAME As Integer = 63
+    ' A system restart is not required. 
+    Private Const RmRebootReasonNone As Integer = 0
+
+    ''' <summary> 
+    ''' Uniquely identifies a process by its PID and the time the process began.  
+    ''' An array of RM_UNIQUE_PROCESS structures can be passed 
+    ''' to the RmRegisterResources function. 
+    ''' </summary> 
+    <StructLayout(LayoutKind.Sequential)>
+    Private Structure RM_UNIQUE_PROCESS
+        ' The product identifier (PID). 
+        Public dwProcessId As Integer
+        ' The creation time of the process. 
+        Public ProcessStartTime As System.Runtime.InteropServices.ComTypes.FILETIME
+    End Structure
+
+    ''' <summary> 
+    ''' Specifies the type of application that is described by 
+    ''' the RM_PROCESS_INFO structure. 
+    ''' </summary> 
+    Private Enum RM_APP_TYPE
+        ' The application cannot be classified as any other type. 
+        RmUnknownApp = 0
+        ' A Windows application run as a stand-alone process that 
+        ' displays a top-level window. 
+        RmMainWindow = 1
+        ' A Windows application that does not run as a stand-alone 
+        ' process and does not display a top-level window. 
+        RmOtherWindow = 2
+        ' The application is a Windows service. 
+        RmService = 3
+        ' The application is Windows Explorer. 
+        RmExplorer = 4
+        ' The application is a stand-alone console application. 
+        RmConsole = 5
+        ' A system restart is required to complete the installation because 
+        ' a process cannot be shut down. 
+        RmCritical = 1000
+    End Enum
+
+    ''' <summary> 
+    ''' Describes an application that is to be registered with the Restart Manager. 
+    ''' </summary> 
+    <StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Auto)>
+    Private Structure RM_PROCESS_INFO
+        ' Contains an RM_UNIQUE_PROCESS structure that uniquely identifies the 
+        ' application by its PID and the time the process began. 
+        Public Process As RM_UNIQUE_PROCESS
+        ' If the process is a service, this parameter returns the  
+        ' long name for the service. 
+        <MarshalAs(UnmanagedType.ByValTStr, SizeConst:=CCH_RM_MAX_APP_NAME + 1)>
+        Public strAppName As String
+        ' If the process is a service, this is the short name for the service. 
+        <MarshalAs(UnmanagedType.ByValTStr, SizeConst:=CCH_RM_MAX_SVC_NAME + 1)>
+        Public strServiceShortName As String
+        ' Contains an RM_APP_TYPE enumeration value. 
+        Public ApplicationType As RM_APP_TYPE
+        ' Contains a bit mask that describes the current status of the application. 
+        Public AppStatus As UInteger
+        ' Contains the Terminal Services session ID of the process. 
+        Public TSSessionId As UInteger
+        ' TRUE if the application can be restarted by the  
+        ' Restart Manager; otherwise, FALSE. 
+        <MarshalAs(UnmanagedType.Bool)>
+        Public bRestartable As Boolean
+    End Structure
+
+    ''' <summary> 
+    ''' Registers resources to a Restart Manager session. The Restart Manager uses  
+    ''' the list of resources registered with the session to determine which  
+    ''' applications and services must be shut down and restarted. Resources can be  
+    ''' identified by filenames, service short names, or RM_UNIQUE_PROCESS structures 
+    ''' that describe running applications. 
+    ''' </summary> 
+    ''' <param name="pSessionHandle"> 
+    ''' A handle to an existing Restart Manager session. 
+    ''' </param> 
+    ''' <param name="nFiles">The number of files being registered</param> 
+    ''' <param name="rgsFilenames"> 
+    ''' An array of null-terminated strings of full filename paths. 
+    ''' </param> 
+    ''' <param name="nApplications">The number of processes being registered</param> 
+    ''' <param name="rgApplications">An array of RM_UNIQUE_PROCESS structures</param> 
+    ''' <param name="nServices">The number of services to be registered</param> 
+    ''' <param name="rgsServiceNames"> 
+    ''' An array of null-terminated strings of service short names. 
+    ''' </param> 
+    ''' <returns>The function can return one of the system error codes that  
+    ''' are defined in Winerror.h 
+    ''' </returns> 
+    <DllImport("rstrtmgr.dll", CharSet:=CharSet.Auto, SetLastError:=True)>
+    Private Function RmRegisterResources(pSessionHandle As UInteger, nFiles As UInt32, rgsFilenames As String(), nApplications As UInt32, <[In]> rgApplications As RM_UNIQUE_PROCESS(), nServices As UInt32,
+        rgsServiceNames As String()) As Integer
+    End Function
+
+    ''' <summary> 
+    ''' Starts a new Restart Manager session. A maximum of 64 Restart Manager  
+    ''' sessions per user session can be open on the system at the same time.  
+    ''' When this function starts a session, it returns a session handle and  
+    ''' session key that can be used in subsequent calls to the Restart Manager API. 
+    ''' </summary> 
+    ''' <param name="pSessionHandle"> 
+    ''' A pointer to the handle of a Restart Manager session. 
+    ''' </param> 
+    ''' <param name="dwSessionFlags">Reserved. This parameter should be 0.</param> 
+    ''' <param name="strSessionKey"> 
+    ''' A null-terminated string that contains the session key to the new session. 
+    ''' </param> 
+    ''' <returns></returns> 
+    <DllImport("rstrtmgr.dll", CharSet:=CharSet.Auto, SetLastError:=True)>
+    Private Function RmStartSession(ByRef pSessionHandle As UInteger, dwSessionFlags As Integer, strSessionKey As String) As Integer
+    End Function
+
+    ''' <summary> 
+    ''' Ends the Restart Manager session. This function should be called by the  
+    ''' primary installer that has previously started the session by calling the  
+    ''' RmStartSession function. The RmEndSession function can be called by a  
+    ''' secondary installer that is joined to the session once no more resources  
+    ''' need to be registered by the secondary installer. 
+    ''' </summary> 
+    ''' <param name="pSessionHandle"> 
+    ''' A handle to an existing Restart Manager session. 
+    ''' </param> 
+    ''' <returns> 
+    ''' The function can return one of the system error codes 
+    ''' that are defined in Winerror.h. 
+    ''' </returns> 
+    <DllImport("rstrtmgr.dll", CharSet:=CharSet.Auto, SetLastError:=True)>
+    Private Function RmEndSession(pSessionHandle As UInteger) As Integer
+    End Function
+
+    ''' <summary> 
+    ''' Gets a list of all applications and services that are currently using  
+    ''' resources that have been registered with the Restart Manager session. 
+    ''' </summary> 
+    ''' <param name="dwSessionHandle"> 
+    ''' A handle to an existing Restart Manager session. 
+    ''' </param> 
+    ''' <param name="pnProcInfoNeeded">A pointer to an array size necessary to  
+    ''' receive RM_PROCESS_INFO structures required to return information for  
+    ''' all affected applications and services. 
+    ''' </param> 
+    ''' <param name="pnProcInfo"> 
+    ''' A pointer to the total number of RM_PROCESS_INFO structures in an array 
+    ''' and number of structures filled. 
+    ''' </param> 
+    ''' <param name="rgAffectedApps"> 
+    ''' An array of RM_PROCESS_INFO structures that list the applications and  
+    ''' services using resources that have been registered with the session. 
+    ''' </param> 
+    ''' <param name="lpdwRebootReasons"> 
+    ''' Pointer to location that receives a value of the RM_REBOOT_REASON 
+    ''' enumeration that describes the reason a system restart is needed. 
+    ''' </param> 
+    ''' <returns></returns> 
+    <DllImport("rstrtmgr.dll", CharSet:=CharSet.Auto, SetLastError:=True)>
+    Private Function RmGetList(dwSessionHandle As UInteger, ByRef pnProcInfoNeeded As UInteger, ByRef pnProcInfo As UInteger, <[In], Out> rgAffectedApps As RM_PROCESS_INFO(), ByRef lpdwRebootReasons As UInteger) As Integer
+    End Function
+
+    Function LockCheck(Filename As String)
+        Dim handle As UInteger
+        Dim sessionkey As String = Guid.NewGuid().ToString()
+        Dim processes As New List(Of Process)()
+        Dim result As String = ""
+
+        Dim res As Integer = RmStartSession(handle, 0, sessionkey)
+        If res <> 0 Then
+            Throw New Exception("Could not begin restart session.")
+        End If
+
+        Try
+            Dim pnProcInfoNeeded As UInteger = 0, pnProcInfo As UInteger = 100, lpdwRebootReasons As UInteger = RmRebootReasonNone
+            Dim resources As String() = New String() {Filename}
+
+            ' Create an array to store the process results. 
+            Dim processInfo As RM_PROCESS_INFO() = New RM_PROCESS_INFO(pnProcInfo - 1) {}
+
+            res = RmRegisterResources(handle, CUInt(resources.Length), resources, 0, Nothing, 0,
+                Nothing)
+            If res <> 0 Then
+                Throw New Exception("Could not register resource.")
+            End If
+
+            res = RmGetList(handle, pnProcInfoNeeded, pnProcInfo, processInfo, lpdwRebootReasons)
+            If res = 0 Then
+                'The function completed successfully. 
+
+                If pnProcInfo <> 0 Then
+                    For i As Integer = 0 To pnProcInfo - 1
+                        'Console.WriteLine("File Name :" + resources(0))
+                        result = result + "File Name :" + resources(0) + vbNewLine
+                        'Console.WriteLine("Application locking the file :" + processInfo(i).strAppName)
+                        result = result + "Application locking the file : " + processInfo(i).strAppName + vbNewLine
+                        result = result + "PID of process locking the file: " + processInfo(i).Process.dwProcessId.ToString() + vbNewLine
+                    Next
+                Else
+                    'Console.WriteLine("The specified file '{0}' is not locked by any process", resources(0))
+                    result = result + "No locks"
+
+                End If
+            Else
+                Throw New Exception("Could not list processes locking resource.")
+            End If
+
+            If res <> 0 Then
+                Throw New Win32Exception(Marshal.GetLastWin32Error())
+
+            End If
+        Catch exception As Exception
+            'Console.WriteLine(exception.Message)
+            result = result + exception.Message
+        Finally
+            RmEndSession(handle)
+        End Try
+        Return result
+    End Function
+End Module
+Public Class LockChecker
+    Public Function CheckLock(FileName As String)
+        Return LockCheck.LockCheck(FileName)
+    End Function
+End Class
diff --git a/LockChecker/LockChecker.vbproj b/LockChecker/LockChecker.vbproj
@@ -0,0 +1,102 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
+  <PropertyGroup>
+    <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
+    <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
+    <ProjectGuid>{029C010D-728B-4B87-B54A-08B2BBF49BD7}</ProjectGuid>
+    <OutputType>Library</OutputType>
+    <RootNamespace>LockChecker</RootNamespace>
+    <AssemblyName>LockChecker</AssemblyName>
+    <FileAlignment>512</FileAlignment>
+    <MyType>Windows</MyType>
+    <TargetFrameworkVersion>v4.0</TargetFrameworkVersion>
+    <Deterministic>true</Deterministic>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
+    <DebugSymbols>true</DebugSymbols>
+    <DebugType>full</DebugType>
+    <DefineDebug>true</DefineDebug>
+    <DefineTrace>true</DefineTrace>
+    <OutputPath>bin\Debug\</OutputPath>
+    <DocumentationFile>LockChecker.xml</DocumentationFile>
+    <NoWarn>42016,41999,42017,42018,42019,42032,42036,42020,42021,42022</NoWarn>
+  </PropertyGroup>
+  <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
+    <DebugType>pdbonly</DebugType>
+    <DefineDebug>false</DefineDebug>
+    <DefineTrace>true</DefineTrace>
+    <Optimize>true</Optimize>
+    <OutputPath>bin\Release\</OutputPath>
+    <DocumentationFile>LockChecker.xml</DocumentationFile>
+    <NoWarn>42016,41999,42017,42018,42019,42032,42036,42020,42021,42022</NoWarn>
+  </PropertyGroup>
+  <PropertyGroup>
+    <OptionExplicit>On</OptionExplicit>
+  </PropertyGroup>
+  <PropertyGroup>
+    <OptionCompare>Binary</OptionCompare>
+  </PropertyGroup>
+  <PropertyGroup>
+    <OptionStrict>Off</OptionStrict>
+  </PropertyGroup>
+  <PropertyGroup>
+    <OptionInfer>On</OptionInfer>
+  </PropertyGroup>
+  <ItemGroup>
+    <Reference Include="System" />
+    <Reference Include="System.Data" />
+    <Reference Include="System.Xml" />
+    <Reference Include="System.Core" />
+    <Reference Include="System.Xml.Linq" />
+    <Reference Include="System.Data.DataSetExtensions" />
+  </ItemGroup>
+  <ItemGroup>
+    <Import Include="Microsoft.VisualBasic" />
+    <Import Include="System" />
+    <Import Include="System.Collections" />
+    <Import Include="System.Collections.Generic" />
+    <Import Include="System.Data" />
+    <Import Include="System.Diagnostics" />
+    <Import Include="System.Linq" />
+    <Import Include="System.Xml.Linq" />
+  </ItemGroup>
+  <ItemGroup>
+    <Compile Include="LockCheck.vb" />
+    <Compile Include="My Project\AssemblyInfo.vb" />
+    <Compile Include="My Project\Application.Designer.vb">
+      <AutoGen>True</AutoGen>
+      <DependentUpon>Application.myapp</DependentUpon>
+    </Compile>
+    <Compile Include="My Project\Resources.Designer.vb">
+      <AutoGen>True</AutoGen>
+      <DesignTime>True</DesignTime>
+      <DependentUpon>Resources.resx</DependentUpon>
+    </Compile>
+    <Compile Include="My Project\Settings.Designer.vb">
+      <AutoGen>True</AutoGen>
+      <DependentUpon>Settings.settings</DependentUpon>
+      <DesignTimeSharedInput>True</DesignTimeSharedInput>
+    </Compile>
+  </ItemGroup>
+  <ItemGroup>
+    <EmbeddedResource Include="My Project\Resources.resx">
+      <Generator>VbMyResourcesResXFileCodeGenerator</Generator>
+      <LastGenOutput>Resources.Designer.vb</LastGenOutput>
+      <CustomToolNamespace>My.Resources</CustomToolNamespace>
+      <SubType>Designer</SubType>
+    </EmbeddedResource>
+  </ItemGroup>
+  <ItemGroup>
+    <None Include="My Project\Application.myapp">
+      <Generator>MyApplicationCodeGenerator</Generator>
+      <LastGenOutput>Application.Designer.vb</LastGenOutput>
+    </None>
+    <None Include="My Project\Settings.settings">
+      <Generator>SettingsSingleFileGenerator</Generator>
+      <CustomToolNamespace>My</CustomToolNamespace>
+      <LastGenOutput>Settings.Designer.vb</LastGenOutput>
+    </None>
+  </ItemGroup>
+  <Import Project="$(MSBuildToolsPath)\Microsoft.VisualBasic.targets" />
+</Project>
diff --git a/LockChecker/My Project/Application.Designer.vb b/LockChecker/My Project/Application.Designer.vb
diff --git a/LockChecker/My Project/Application.myapp b/LockChecker/My Project/Application.myapp
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<MyApplicationData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
+  <MySubMain>false</MySubMain>
+  <SingleInstance>false</SingleInstance>
+  <ShutdownMode>0</ShutdownMode>
+  <EnableVisualStyles>true</EnableVisualStyles>
+  <AuthenticationMode>0</AuthenticationMode>
+  <ApplicationType>1</ApplicationType>
+  <SaveMySettingsOnExit>true</SaveMySettingsOnExit>
+</MyApplicationData>
diff --git a/LockChecker/My Project/AssemblyInfo.vb b/LockChecker/My Project/AssemblyInfo.vb
@@ -0,0 +1,35 @@
+Imports System
+Imports System.Reflection
+Imports System.Runtime.InteropServices
+
+' General Information about an assembly is controlled through the following
+' set of attributes. Change these attribute values to modify the information
+' associated with an assembly.
+
+' Review the values of the assembly attributes
+
+<Assembly: AssemblyTitle("LockChecker")>
+<Assembly: AssemblyDescription("")>
+<Assembly: AssemblyCompany("")>
+<Assembly: AssemblyProduct("LockChecker")>
+<Assembly: AssemblyCopyright("Copyright ©  2019")>
+<Assembly: AssemblyTrademark("")>
+
+<Assembly: ComVisible(False)>
+
+'The following GUID is for the ID of the typelib if this project is exposed to COM
+<Assembly: Guid("6422a30e-03d9-4b6d-af72-79c2a4b849a1")>
+
+' Version information for an assembly consists of the following four values:
+'
+'      Major Version
+'      Minor Version
+'      Build Number
+'      Revision
+'
+' You can specify all the values or you can default the Build and Revision Numbers
+' by using the '*' as shown below:
+' <Assembly: AssemblyVersion("1.0.*")>
+
+<Assembly: AssemblyVersion("1.0.0.0")>
+<Assembly: AssemblyFileVersion("1.0.0.0")>