CODEWITHSUNDEEP
powershell
Nick
Nick

Reputation: 8319

Store Entire Text File Contents in Variable

I'd like to use PowerShell to store the entire contents of a text file (including the trailing blank line that may or may not exist) in a variable. I'd also like to know the total number of lines in the text file. What's the most efficient way to do this?

Upvotes: 172

Views: 267367

Answers (6)

Ingmar
Ingmar

Reputation: 2658

Read binary file:

This is not exactly what was asked, but some might find this useful for their use case anyway. Get-Content -Raw yields a string, so if you want byte[]:

Get-Content c:\file.bin -Encoding Byte -ReadCount 0

-Read-Count tells how many lines go through the pipeline at a time (default is 1), and 0 does everything in one operation which boosts performance.

The credits shall go to Shay Levy who has published this solution: (see Shay's post here)

Upvotes: 2

Jerry T.
Jerry T.

Reputation: 31

Get-Content grabs data and dumps it into an array, line by line. Assuming there aren't other special requirements than you listed, you could just save your content into a variable?

$file = Get-Content c:\file\whatever.txt

Running just $file will return the full contents. Then you can just do $file.Count (because arrays already have a count method built in) to get the total # of lines.

Hope this helps! I'm not a scripting wiz, but this seemed easier to me than a lot of the stuff above.

Upvotes: 3

Kapé
Kapé

Reputation: 4811

Powershell 2.0:

(see detailed explanation here)

$text = Get-Content $filePath | Out-String

The IO.File.ReadAllText didn't work for me with a relative path, it looks for the file in %USERPROFILE%\$filePath instead of the current directory (when running from Powershell ISE at least):

$text = [IO.File]::ReadAllText($filePath)

Powershell 3+:

$text = Get-Content $filePath -Raw

Upvotes: 34

Michael Sorens
Michael Sorens

Reputation: 36758

One more approach to reading a file that I happen to like is referred to variously as variable notation or variable syntax and involves simply enclosing a filespec within curly braces preceded by a dollar sign, to wit:

$content = ${C:file.txt}

This notation may be used as either an L-value or an R-value; thus, you could just as easily write to a file with something like this:

 ${D:\path\to\file.txt} = $content

Another handy use is that you can modify a file in place without a temporary file and without sub-expressions, for example:

${C:file.txt} = ${C:file.txt} | select -skip 1

I became fascinated by this notation initially because it was very difficult to find out anything about it! Even the PowerShell 2.0 specification mentions it only once showing just one line using it--but with no explanation or details of use at all. I have subsequently found this blog entry on PowerShell variables that gives some good insights.

One final note on using this: you must use a drive designation, i.e. ${drive:filespec} as I have done in all the examples above. Without the drive (e.g. ${file.txt}) it does not work. No restrictions on the filespec on that drive: it may be absolute or relative.

Upvotes: 18

Shay Levy
Shay Levy

Reputation: 126912

On a side note, in PowerShell 3.0 you can use the Get-Content cmdlet with the new Raw switch:

$text = Get-Content .\file.txt -Raw

Upvotes: 268

manojlds
manojlds

Reputation: 301477

To get the entire contents of a file:

$content = [IO.File]::ReadAllText(".\test.txt")

Number of lines:

([IO.File]::ReadAllLines(".\test.txt")).length

or

(gc .\test.ps1).length

Sort of hackish to include trailing empty line:

[io.file]::ReadAllText(".\desktop\git-python\test.ps1").split("`n").count

Upvotes: 152

Related Questions