Added Get-OZOFileIsLocked; minor bugs and documentation updates; v1.1.0

* Added Get-OZOFileIsLocked; minor bugs and documentation updates; v1.1.0

---------

Co-authored-by: Andy Lievertz <alievertz@onezeroone.dev>

Author: alievertz

CHANGELOG.md

@@ -2,4 +2,5 @@
 
 |Date|Version|Comment|
 |----|-------|-------|
+|2025-Jun-01|1.1.0|Added `Get-OZOFileIsLocked`; minor bugs and documentation updates.|
 |2025-May-19|1.0.0|Initial release including `Get-OZODirectorySummary`.|

Documentation/Get-OZOFileIsLocked.md

@@ -0,0 +1,25 @@
+# Get-OZOFileIsLocked
+This function is part of the [OZOFiles PowerShell Module](../README.md).
+
+## Description
+Returns _True_ if the Path is locked or _False_ if the path is not locked, does not exist, is not accessible, or is a directory.
+
+## Syntax
+```
+Get-OZOFileIsLocked
+    -Path <String>
+```
+
+## Parameters
+|Parameter|Description|
+|---------|-----------|
+|`Path`|The path of the file to inspect.|
+
+## Examples
+```powershell
+Get-OZOFileIsLocked -Path "C:\Temp\test.txt"
+False
+```
+
+## Outputs
+`System.Boolean`

Documentation/OZODirectorySummary.md

@@ -1,6 +1,11 @@
 # OZODirectorySummary Class
-This class is part of the [OZOFiles PowerShell Module](../README.md). Calling the `Get-OZODirectorySummary` function returns an object of the `OZODirectorySummary` class.
+This class is part of the [OZOFiles PowerShell Module](../README.md).
 
+## Usage
+Use the [`Get-OZODirectorySummary`](Get-OZODirectorySummary.md) function to return an object of this class.
+
+## Definition
+### Associations
 ```
 + $Validates:Boolean             = $true
 + $newestChildWriteTime:DateTime = (Get-Date -Year 1970 -Month 01 -Day 01 -Hour 00 -Minute 00 -Second 00)
@@ -11,8 +16,9 @@ This class is part of the [OZOFiles PowerShell Module](../README.md). Calling th
 + $longPaths:System.Collections.Generic.List[System.IO.FileSystemInfo]    = @()
 + $problemPaths:System.Collections.Generic.List[System.IO.FileSystemInfo] = @()
 ```
----
+### Operations
 ```
 + OZODirectorySummary($LongLength,$Path):void
 - ValidateEnvironment():Boolean
 - GetDirectorySummary():Boolean
+```

Documentation/Test-OZOPath.md

@@ -7,20 +7,28 @@ Determines if a path exists and is readable. Optionally tests if the path is wri
 ## Syntax
 ```
 Test-OZOPath
-    -Path <String>
+    -Path     <String>
+    -Writable <Switch>
 ```
 
 ## Parameters
 |Parameter|Description|
 |---------|-----------|
-|`Path`|The path to test. Returns TRUE if the path exists and is readable and otherwise returns FALSE.|
-|`Writable`|Determines if the path is writable. Returns TRUE if the path is writable and otherwise returns FALSE.|
+|`Path`|The path to test. Returns _True_ if the path exists and is readable and otherwise returns _False_.|
+|`Writable`|Determines if the path is writable. Returns _True_ if the path is writable and otherwise returns _False_.|
 
 ## Examples
+### Example 1
 ```powershell
-Test-OZOPath -Path ".\README.md"
+Test-OZOPath -Path "C:\Windows\notepad.exe"
 True
 ```
 
+### Example 2
+```powershell
+Test-OZOPath -Path "C:\Windows\notepad.exe" -Writable
+False
+```
+
 ## Outputs
 `System.Boolean`

OZOFiles/OZOFiles.psd1

@@ -160,6 +160,50 @@ Function Get-OZODirectorySummary {
     return [OZODirectorySummary]::new($LongLength,$Path)
 }
 
+Function Get-OZOFileIsLocked {
+    <#
+        .SYNOPSIS
+        See description.
+        .DESCRIPTION
+        Returns True if the Path is locked or False if the path is not locked, does not exist, is not accessible, is read-only, or is a directory.
+        .PARAMETER Path
+        The path of the file to inspect.
+        .EXAMPLE
+        Get-OZOFileIsLocked -Path "C:\Temp\test.txt"
+        False
+        .LINK
+        https://github.com/onezeroone-dev/OZOFiles-PowerShell-Module/blob/main/Documentation/Get-OZOFileIsLocked.md
+    #>
+    # Parameters
+    [CmdletBinding()] Param(
+        [Parameter(Mandatory=$true,ValueFromPipeline=$true,ValueFromPipelineByPropertyName=$true)][Alias("FullName","PSPath")][String[]]$Path
+    )
+    # Try to get the item
+    Try {
+        $Item = (Get-Item -Path $Path -ErrorAction Stop)
+        # Success; determine if Item is a file
+        If ($Item.PSIsContainer -eq $false) {
+            # Item is a file; try to open it
+            Try {
+                $fileStream = [System.IO.File]::Open($Item.FullName,"Open","Write")
+                $fileStream.Close()
+                $fileStream.Dispose()
+                # Success
+                return $false
+            } Catch {
+                # Failure
+                return $true
+            }
+        } Else {
+            # Item is a directory
+            return $false
+        }
+    } Catch {
+        # Failure
+        return $false
+    }
+}
+
 Function Get-OZOFileToBase64 {
     <#
         .SYNOPSIS
@@ -235,8 +279,11 @@ Function Test-OZOPath {
         .PARAMETER Writable
         Determines if the path is writable. Returns TRUE if the path is writable and otherwise returns FALSE.
         .EXAMPLE
-        Test-OZOPath -Path .\README.md
+        Test-OZOPath -Path "C:\Windows\notepad.exe"
         True
+        .EXAMPLE
+        Test-OZOPath -Path "C:\Windows\notepad.exe" -Writable
+        False
         .LINK
         https://github.com/onezeroone-dev/OZOFiles-PowerShell-Module/blob/main/Documentation/Test-OZOPath.md
     #>
@@ -288,4 +335,4 @@ Function Test-OZOPath {
     }
 }
 
-Export-ModuleMember -Function Get-OZOChildWriteTime,Get-OZODirectorySummary,Get-OZOFileToBase64,Set-OZOBase64ToFile,Test-OZOPath
+Export-ModuleMember -Function Get-OZOChildWriteTime,Get-OZODirectorySummary,Get-OZOFileIsLocked,Get-OZOFileToBase64,Set-OZOBase64ToFile,Test-OZOPath

OZOFiles/OZOFiles.psm1

@@ -17,10 +17,18 @@ Import-Module OZOFiles
 ## Functions
 
 - [Get-OZOChildWriteTime](Documentation/Get-OZOChildWriteTime.md)
+- [Get-OZODirectorySummary](Documentation/Get-OZODirectorySummary.md)
+- [Get-OZOFileIsLocked](Documentation/Get-OZOFileIsLocked.md)
 - [Get-OZOFileToBase64](Documentation/Get-OZOFileToBase64.md)
 - [Set-OZOBase64ToFile](Documentation/Set-OZOBase64tofile.md)
 - [Test-OZOPath](Documentation/Test-OZOPath.md)
 
 ## Classes
 
 - [OZODirectorySummary](Documentation/OZODirectorySummary.md)
+
+## License
+This module is licensed under the [GNU General Public License (GPL) version 2.0](LICENSE).
+
+## Acknowledgements
+Special thanks to my employer, [Sonic Healthcare USA](https://sonichealthcareusa.com), who supports the growth of my PowerShell skillset and enables me to contribute portions of my work product to the PowerShell community.