Out-File - PowerShell 1.0
Microsoft Windows PowerShell is a command-line shell and scripting tool based on the Microsoft .NET Framework. It is designed for system administrators, engineers and developers to control and automate the administration of Windows and applications.
More than hundred command-line tools (so called "cmdlets") can be used to perform system administration tasks and Windows Management Instrumentation (WMI). These cmdlets are easy to use, with standard naming conventions and common parameters, and standard tools for piping, sorting, filtering, and formatting data and objects.
Out-File
Description
Back up your Hyper-V VMs Easy & Fast. 100% built for Hyper-V. Free for 2 VMs, forever.
Usage
Options
-filePath path
The path to the output file.
-encoding string
The character encoding used in the file.
"Unicode", "UTF7", "UTF8", "UTF32", "ASCII", "BigEndianUnicode",
"Default", or "OEM". The default is Unicode.
Default=system ANSI code page.
OEM=OEM code page identifier for the OS.
-append
Add the output to the end of an existing file, instead of replacing
the file contents.
-width int
The number of characters in each line of output. Any additional
characters are truncated, not wrapped. If you omit this parameter,
the width is determined by the characteristics of the host. The default
for the PowerShell.exe host is 80 (characters).
-inputObject psobject
The object to be written to file. {may be piped}
A command, expression or variabale that contains the objects.
-force
Override restrictions that prevent the command from succeeding, apart
from security settings. e.g. Force will create file path directories
or override a files read-only attribute, but will not change file permissions.
-noClobber
Do not overwrite (replace the contents) of an existing file.
By default Out-File will overwrite an existing file without warning.
If both -Append and -NoClobber are specified, the output is appended.
-whatIf
Describe what would happen if you executed the command without
actually executing the command.
-confirm
Prompt for confirmation before executing the command.
CommonParameters:
-Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutVariable.
Example(s)
Send a list of processes to process.txt:
PS C:\>get-process | out-file -filepath C:\docs\process.txt
PS C:\>get-process | out-file C:\docs\process.txt
The same thing, but storing the list of processes in a variable first and truncating the output at 50 characters:
PS C:\>$a = get-process
out-file -filepath C:\docs\process.txt -inputobject $a -width 50
Save a registry key to file :
PS C:\>set-location hklm:\software
PS HKLM:\software>get-acl ODBC | out-file c:\docs\acl.txt -width 200