Register-FileSystemWatcher.ps1

19 Sep 2025

• Description
  • Purpose
  • Detailed Description
  • Usage
  • Notes
  • Script
  • Download
  • Report Issues

---

Description

Purpose

No synopsis provided.

Detailed Description

No detailed description provided.

Back to Top

Usage

No usage examples provided.

Back to Top

Notes

No additional notes.

Back to Top

---

Script

function Register-FileSystemWatcher {

    [CmdletBinding(DefaultParameterSetName = 'Default',
        PositionalBinding = $true,
        SupportsShouldProcess = $true)]
    [OutputType([string], ParameterSetName = 'Default')]
    [Alias('New-FileWatcher')]
    Param
    (
        [Parameter(ParameterSetName = 'Default',
            Mandatory = $true,
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            ValueFromRemainingArguments = $true,
            Position = 0,
            HelpMessage = 'Enter something')]
        [string]$file,

        [Parameter(ParameterSetName = 'Default',
            Mandatory = $true,
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            ValueFromRemainingArguments = $true,
            Position = 1,
            HelpMessage = 'Enter something')]
        [scriptblock] $cmd,

        [Parameter(ParameterSetName = 'Default',
            Mandatory = $false,
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            ValueFromRemainingArguments = $true,
            HelpMessage = 'Enter something')]
        $filter = "*.*",

        [Parameter(ParameterSetName = 'Default',
            Mandatory = $false,
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            ValueFromRemainingArguments = $true,
            HelpMessage = 'Enter something')]
        [ValidateSet("Created", "Changed", "Deleted", "Renamed")]
        $events = @("Created", "Changed", "Deleted", "Renamed"),

        [Parameter(ParameterSetName = 'Default',
            Mandatory = $true,
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            ValueFromRemainingArguments = $true,
            HelpMessage = 'Enter something')]
        [switch][bool] $loop,

        [Parameter(ParameterSetName = 'Default',
            Mandatory = $true,
            ValueFromPipeline = $true,
            ValueFromPipelineByPropertyName = $true,
            ValueFromRemainingArguments = $true,
            HelpMessage = 'Enter something')]
        [switch][bool] $nowait

    )

    ### SET FOLDER TO WATCH + FILES TO WATCH + SUBFOLDERS YES/NO
    $watcher = New-Object System.IO.FileSystemWatcher
    $watcher.Path = (Get-Item $file).FullName
    $watcher.Filter = $filter
    $watcher.IncludeSubdirectories = $true
    $watcher.EnableRaisingEvents = $true

    ### DEFINE ACTIONS AFTER AN EVENT IS DETECTED
    $action = {
        try {
            #$event | format-table | out-string | write-verbose -verbose
            #$event.MessageData | out-string | write-verbose -verbose
            #$event.MessageData.gettype() | out-string | write-verbose -verbose
            $path = $Event.SourceEventArgs.FullPath
            $changeType = $Event.SourceEventArgs.ChangeType
            Write-Verbose "[$(Get-Date)] $changeType, $path" -Verbose
            Invoke-Command $event.MessageData.cmd -ArgumentList $path, $changeType -Verbose
            Write-Verbose "[$(Get-Date)] DONE $changeType, $path" -Verbose
            if ($event.MessageData.loop) {
                #Register-ObjectEvent $event.sender -EventName $changeType -Action $event.MessageData.action -MessageData $event.MessageData
            }
        }
        catch {
            Write-Error $_
            throw
        }
    }

    ### DECIDE WHICH EVENTS SHOULD BE WATCHED
    $jobs = $events | ForEach-Object {
        Register-ObjectEvent $watcher $_ -Action $action -MessageData @{ action = $action; cmd = $cmd; loop = $loop }
    }
    if (!$nowait) {
        try {
            while ($true) { Start-Sleep 1 }
        }
        finally {
            Stop-Job $jobs
        }
    }
}

Back to Top

Download

Please feel free to copy parts of the script or if you would like to download the entire script, simply click the download button. You can download the complete repository in a zip file by clicking the Download link in the menu bar on the left hand side of the page.

---

Report Issues

You can report an issue or contribute to this site on GitHub. Simply click the button below and add any relevant notes. I will attempt to respond to all issues as soon as possible.

Issue

---

Back to Top