Get-Content -wait not working as described in the documentation

by

Edit: Bernhard König reports in the comments that this has finally been fixed in Powershell 5.

You are quite right. The -Wait option on Get-Content waits until the file has been closed before it reads more content. It is possible to demonstrate this in Powershell, but can be tricky to get right as loops such as:

while (1){
get-date | add-content c:\tesetfiles\test1.txt 
Start-Sleep -Milliseconds 500
}

will open and close the output file every time round the loop.

To demonstrate the issue open two Powershell windows (or two tabs in the ISE). In one enter this command:

PS C:\> 1..30 | % { "${_}: Write $(Get-Date -Format "hh:mm:ss")"; start-sleep 1 } >C:\temp\t.txt

That will run for 30 seconds writing 1 line into the file each second, but it doesn’t close and open the file each time.

In the other window use Get-Content to read the file:

get-content c:\temp\t.txt -tail 1 -wait | % { "$_ read at $(Get-Date -Format "hh:mm:ss")" }

With the -Wait option you need to use Ctrl+C to stop the command so running that command 3 times waiting a few seconds after each of the first two and a longer wait after the third gave me this output:

PS C:\> get-content c:\temp\t.txt -tail 1 -wait | % { "$_ read at $(Get-Date -Format "hh:mm:ss")" }
8: Write 12:15:09 read at 12:15:09

PS C:\> get-content c:\temp\t.txt -tail 1 -wait | % { "$_ read at $(Get-Date -Format "hh:mm:ss")" }
13: Write 12:15:14 read at 12:15:15

PS C:\> get-content c:\temp\t.txt -tail 1 -wait | % { "$_ read at $(Get-Date -Format "hh:mm:ss")" }
19: Write 12:15:20 read at 12:15:20
20: Write 12:15:21 read at 12:15:32
21: Write 12:15:22 read at 12:15:32
22: Write 12:15:23 read at 12:15:32
23: Write 12:15:24 read at 12:15:32
24: Write 12:15:25 read at 12:15:32
25: Write 12:15:26 read at 12:15:32
26: Write 12:15:27 read at 12:15:32
27: Write 12:15:28 read at 12:15:32
28: Write 12:15:29 read at 12:15:32
29: Write 12:15:30 read at 12:15:32
30: Write 12:15:31 read at 12:15:32

From this I can clearly see:

  1. Each time the command is run it gets the latest line written to the file. i.e. There is no problem with caching and no buffers needing flushed.
  2. Only a single line is read and then no further output appears until the command running in the other window completes.
  3. Once it does complete all of the pending lines appear together. This must have been triggered by the source program closing the file.

Also when I repeated the exercise with the Get-Content command running in two other windows one window read line 3 then just waited, the other window read line 6, so the line is definitely being written to the file.

It seems pretty conclusive that the -Wait option is waiting for a file close event, not waiting for the advertised 1 second. The documentation is wrong.

Edit:
I should add, as Adi Inbar seems to insistent that I’m wrong, that the examples I gave here use Powershell only as that seemed most appropriate for a Powershell discussion. I did also verify using Python that the behaviour is exactly as I described:

Content written to a file is readable by a new Get-Content -Wait command immediately provided the application has flushed its buffer.

A Powershell instance using Get-Content -Wait will not display new content in the file that is being written even though another Powershell instance, started later, sees the later data. This proves conclusively that the data is accessible to Powershell and Get-Content -Wait is not polling at 1 second intervals but waiting for some trigger event before it next looks for data.

The size of the file as reported by dir is updating while lines are being added, so it is not a case of Powershell waiting for the directory entry size to be updated.

When the process writing the file closes it, the Get-Content -Wait displays the new content almost instantly. If it were waiting until the data was flushed to disk there would be up to a delay until Windows flushed it’s disk cache.

@AdiInbar, I’m afraid you don’t understand what Excel does when you save a file. Have a closer look. If you are editing test.xlsx then there is also a hidden file ~test.xlsx in the same folder. Use dir ~test.xlsx -hidden | select CreationTime to see when it was created. Save your file and now test.xlsx will have the creation time from ~test.xlsx. In other words saving in Excel saves to the ~ file then deletes the original, renames the ~ file to the original name and creates a new ~ file. There’s a lot of opening and closing going on there.

Before you save it has the file you are looking at open, and after that file is open, but its a different file. I think Excel is too complex a scenario to say exactly what triggers Get-Content to show new content but I’m sure you mis-interpreted it.

More Related Contents:

  1. Get-Aduser -Filter will not accept a variable
  2. Delete files older than 15 days using PowerShell
  3. How to load assemblies in PowerShell?
  4. try, catch doesent seem to work
  5. How to get Powershell Invoke-Restmethod to return body of http 500 code response
  6. Powershell ConvertTo-json with embedded hashtable
  7. How Does Member Enumeration Work in PowerShell 3?
  8. Powershell script to see currently logged in users (domain and machine) + status (active, idle, away)
  9. Powershell Using Start-Process in PSSession to Open Notepad
  10. ConvertTo-JSON an array with a single item
  11. Powershell – Reboot and Continue Script
  12. Check if a file exists or not in Windows PowerShell?
  13. PowerShell is missing the terminator: “
  14. Using PowerShell to remove lines from a text file if it contains a string
  15. Difference between PowerShell Console and PowerShell ISE
  16. Powershell: Set a Scheduled Task to run when user isn’t logged in
  17. List of all colors available for PowerShell?
  18. PowerShell script not zipping correct files
  19. Pass arguments to a scriptblock in powershell
  20. How can I do a screen capture in Windows PowerShell?
  21. Powershell – escaping string passed to child process
  22. Powershell Log Off Remote Session
  23. How to pass a custom function inside a ForEach-Object -Parallel
  24. In what conditions does powershell unroll items in the pipeline?
  25. Exit code from a batch file is not propagated to the parent powershell script
  26. In Powershell what is the idiomatic way of converting a string to an int?
  27. How to execute a PowerShell script only before a web deploy Publish task in VS 2012?
  28. Jenkins powershell plugin is running 32 bit Powershell and I need 64bit
  29. Powershell – Output Color for certain results
  30. Pass function as a parameter

Leave a Comment