Powershell out file excel

Out-File

Sends output to a file.

Syntax

Description

The Out-File cmdlet sends output to a file. It implicitly uses PowerShell’s formatting system to write to the file. The file receives the same display representation as the terminal. This means that the output may not be ideal for programmatic processing unless all input objects are strings. When you need to specify parameters for the output, use Out-File rather than the redirection operator ( > ). For more information about redirection, see about_Redirection.

Examples

Example 1: Send output and create a file

This example shows how to send a list of the local computer’s processes to a file. If the file does not exist, Out-File creates the file in the specified path.

The Get-Process cmdlet gets the list of processes running on the local computer. The Process objects are sent down the pipeline to the Out-File cmdlet. Out-File uses the FilePath parameter and creates a file in the current directory named Process.txt. The Get-Content command gets content from the file and displays it in the PowerShell console.

Example 2: Prevent an existing file from being overwritten

This example prevents an existing file from being overwritten. By default, Out-File overwrites existing files.

The Get-Process cmdlet gets the list of processes running on the local computer. The Process objects are sent down the pipeline to the Out-File cmdlet. Out-File uses the FilePath parameter and attempts to write to a file in the current directory named Process.txt. The NoClobber parameter prevents the file from being overwritten and displays a message that the file already exists.

Example 3: Send output to a file in ASCII format

This example shows how to encode output with a specific encoding type.

The Get-Process cmdlet gets the list of processes running on the local computer. The Process objects are stored in the variable, $Procs . Out-File uses the FilePath parameter and creates a file in the current directory named Process.txt. The InputObject parameter passes the process objects in $Procs to the file Process.txt. The Encoding parameter converts the output to ASCII format. The Width parameter limits each line in the file to 50 characters so some data might be truncated.

Example 4: Use a provider and send output to a file

This example shows how to use the Out-File cmdlet when you are not in a FileSystem provider drive. Use the Get-PSProvider cmdlet to view the providers on your local computer. For more information, see about_Providers.

The Set-Location command uses the Path parameter to set the current location to the registry provider Alias: . The Get-Location cmdlet displays the complete path for Alias: . Get-ChildItem sends objects down the pipeline to the Out-File cmdlet. Out-File uses the FilePath parameter to specify the complete path and filename for the output, C:TestDirAliasNames.txt. The Get-Content cmdlet uses the Path parameter and displays the file’s content in the PowerShell console.

Example 5: Set file output width for entire scope

This example uses $PSDefaultParameterValues to set the Width parameter for all invocations of Out-File and the redirection operartors ( > and >> ) to 2000. This ensures that everywhere within the current scope that you output table formatted data to file, PowerShell uses a line width of 2000 instead of a line width determined by the PowerShell host’s console width.

For more information about $PSDefaultParameterValues , see about_Preference_Variables.

Parameters

-Append

Adds the output to the end of an existing file.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Encoding

Specifies the type of encoding for the target file. The default value is utf8NoBOM .

The acceptable values for this parameter are as follows:

• ascii : Uses the encoding for the ASCII (7-bit) character set.
• bigendianunicode : Encodes in UTF-16 format using the big-endian byte order.
• bigendianutf32 : Encodes in UTF-32 format using the big-endian byte order.
• oem : Uses the default encoding for MS-DOS and console programs.
• unicode : Encodes in UTF-16 format using the little-endian byte order.
• utf7 : Encodes in UTF-7 format.
• utf8 : Encodes in UTF-8 format.
• utf8BOM : Encodes in UTF-8 format with Byte Order Mark (BOM)
• utf8NoBOM : Encodes in UTF-8 format without Byte Order Mark (BOM)
• utf32 : Encodes in UTF-32 format.

Beginning with PowerShell 6.2, the Encoding parameter also allows numeric IDs of registered code pages (like -Encoding 1251 ) or string names of registered code pages (like -Encoding «windows-1251» ). For more information, see the .NET documentation for Encoding.CodePage.

UTF-7* is no longer recommended to use. As of PowerShell 7.1, a warning is written if you specify utf7 for the Encoding parameter.

Type:	Encoding
Accepted values:	ASCII, BigEndianUnicode, BigEndianUTF32, OEM, Unicode, UTF7, UTF8, UTF8BOM, UTF8NoBOM, UTF32
Position:	1
Default value:	UTF8NoBOM
Accept pipeline input:	False
Accept wildcard characters:	False

-FilePath

Specifies the path to the output file.

Type:	String
Aliases:	Path
Position:	0
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Overrides the read-only attribute and overwrites an existing read-only file. The Force parameter does not override security restrictions.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Specifies the objects to be written to the file. Enter a variable that contains the objects or type a command or expression that gets the objects.

Type:	PSObject
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-LiteralPath

Specifies the path to the output file. The LiteralPath parameter is used exactly as it is typed. Wildcard characters are not accepted. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell PowerShell not to interpret any characters as escape sequences. For more information, see about_Quoting_Rules.

Type:	String
Aliases:	PSPath, LP
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-NoClobber

NoClobber prevents an existing file from being overwritten and displays a message that the file already exists. By default, if a file exists in the specified path, Out-File overwrites the file without warning.

Type:	SwitchParameter
Aliases:	NoOverwrite
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-NoNewline

Specifies that the content written to the file does not end with a newline character. The string representations of the input objects are concatenated to form the output. No spaces or newlines are inserted between the output strings. No newline is added after the last output string.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Width

Specifies the number of characters in each line of output. Any additional characters are truncated, not wrapped. If this parameter is not used, the width is determined by the characteristics of the host. The default for the PowerShell console is 80 characters. If you want to control the width for all invocations of Out-File as well as the redirection operators ( > and >> ), set $PSDefaultParameterValues[‘out-file:width’] = 2000 before using Out-File .

Type:	Int32
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

You can pipe any object to this cmdlet.

Outputs

None

This cmdlet returns no output.

Notes

Input objects are automatically formatted as they would be in the terminal, but you can use a Format-* cmdlet to explicitly control the formatting of the output to the file. For example, Get-Date | Format-List | Out-File out.txt

To send a PowerShell command’s output to the Out-File cmdlet, use the pipeline. Alternatively, you can store data in a variable and use the InputObject parameter to pass data to the Out-File cmdlet.

Out-File saves data to a file but it does not produce any output objects to the pipeline.

Источник

Out-File

Отправляет выходные данные в файл.

Синтаксис

Описание

Командлет Out-File отправляет выходные данные в файл. Он неявно использует систему форматирования PowerShell для записи в файл. Файл получает то же отображаемое представление, что и терминал. Это означает, что выходные данные не могут быть идеальными для программной обработки, если только все входные объекты не являются строками. Если необходимо указать параметры для выходных данных, используйте Out-File вместо оператора перенаправления ( > ). Дополнительные сведения о перенаправлении см. в разделе about_Redirection.

Примеры

Пример 1. Отправка выходных данных и создание файла

В этом примере показано, как отправить список процессов локального компьютера в файл. Если файл не существует, Out-File создает файл по указанному пути.

Командлет Get-Process получает список процессов, выполняемых на локальном компьютере. Объекты Process отправляются по конвейеру в Out-File командлет . Out-File использует параметр FilePath и создает файл в текущем каталоге с именемProcess.txt. Команда Get-Content получает содержимое из файла и отображает его в консоли PowerShell.

Пример 2. Предотвращение перезаписи существующего файла

В этом примере предотвращается перезапись существующего файла. По умолчанию Out-File перезаписывает существующие файлы.

Командлет Get-Process получает список процессов, выполняемых на локальном компьютере. Объекты Process отправляются по конвейеру в Out-File командлет . Out-File использует параметр FilePath и пытается выполнить запись в файл в текущем каталоге с именемProcess.txt. Параметр NoClobber предотвращает перезапись файла и отображает сообщение о том, что файл уже существует.

Пример 3. Отправка выходных данных в файл в формате ASCII

В этом примере показано, как кодировать выходные данные с определенным типом кодирования.

Командлет Get-Process получает список процессов, выполняемых на локальном компьютере. Объекты Process хранятся в переменной $Procs . Out-File использует параметр FilePath и создает файл в текущем каталоге с именемProcess.txt. Параметр InputObject передает объекты процесса в $Procs файл Process.txt. Параметр Encoding преобразует выходные данные в формат ASCII . Параметр Width ограничивает каждую строку в файле 50 символами, поэтому некоторые данные могут быть усечены.

Пример 4. Использование поставщика и отправка выходных данных в файл

В этом примере показано, как использовать Out-File командлет, если вы не находитесь на диске поставщика файловой системы . Get-PSProvider Используйте командлет для просмотра поставщиков на локальном компьютере. Дополнительные сведения см. в разделе about_Providers.

Команда Set-Location использует параметр Path , чтобы задать текущее расположение для поставщика Alias: реестра . Командлет Get-Location отображает полный путь для Alias: . Get-ChildItem отправляет объекты вниз по конвейеру командлету Out-File . Out-File использует параметр FilePath , чтобы указать полный путь и имя файла для выходных данных ,C:TestDirAliasNames.txt. Командлет Get-Content использует параметр Path и отображает содержимое файла в консоли PowerShell.

Пример 5. Установка ширины выходных данных файла для всей области

В этом примере используется $PSDefaultParameterValues , чтобы задать Width для параметра для всех вызовов и операторов Out-File перенаправления ( > и >> ) значение 2000. Это гарантирует, что везде в текущей области, в которую вы выводите данные в формате таблицы в файл, PowerShell использует ширину линии 2000, а не ширину линии, определяемую шириной консоли узла PowerShell.

Дополнительные сведения о $PSDefaultParameterValues см. в разделе about_Preference_Variables.

Параметры

-Append

Добавляет выходные данные в конец существующего файла.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Запрос подтверждения перед выполнением командлета.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Encoding

Указывает тип кодировки для целевого файла. Значение по умолчанию — utf8NoBOM .

Ниже приведены допустимые значения для этого параметра.

• ascii : использует кодировку для 7-разрядной кодировки ASCII.
• bigendianunicode : кодирует в формате UTF-16 с использованием порядка байтов с большим байтом.
• bigendianutf32 : кодирует в формате UTF-32 с использованием порядка байтов с большим байтом.
• oem : использует кодировку по умолчанию для MS-DOS и консольных программ.
• unicode : кодирует в формате UTF-16 с использованием порядка байтов с маленьким порядком байтов.
• utf7 : кодирует в формате UTF-7.
• utf8 : кодирует в формате UTF-8.
• utf8BOM : кодирует в формате UTF-8 с меткой порядка байтов (BOM)
• utf8NoBOM : кодирует в формате UTF-8 без метки порядка байтов (BOM)
• utf32 : кодирует в формате UTF-32.

Начиная с PowerShell 6.2, параметр Encoding также разрешает числовые идентификаторы зарегистрированных кодовых страниц (например -Encoding 1251 , ) или строковые имена зарегистрированных кодовых страниц (например -Encoding «windows-1251» , ). Дополнительные сведения см. в документации по .NET для Encoding.CodePage.

UTF-7* больше не рекомендуется использовать. В PowerShell 7.1 выдается предупреждение, если вы указываете utf7 для параметра Encoding .

Type:	Encoding
Accepted values:	ASCII, BigEndianUnicode, BigEndianUTF32, OEM, Unicode, UTF7, UTF8, UTF8BOM, UTF8NoBOM, UTF32
Position:	1
Default value:	UTF8NoBOM
Accept pipeline input:	False
Accept wildcard characters:	False

-FilePath

Указывает путь к выходному файлу.

Type:	String
Aliases:	Path
Position:	0
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Переопределяет атрибут только для чтения и перезаписывает существующий файл, доступный только для чтения. Параметр Force не переопределяет ограничения безопасности.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Указывает объекты, которые нужно записать в файл. Введите переменную, которая содержит объекты, или команду или выражение, которое возвращает объекты.

Type:	PSObject
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-LiteralPath

Указывает путь к выходному файлу. Параметр LiteralPath используется точно так же, как он типизированный. Подстановочные знаки не принимаются. Если путь содержит escape-символы, заключите его в одинарные кавычки. Одинарные кавычки предписывают PowerShell не интерпретировать какие-либо символы как escape-последовательности. Дополнительные сведения см. в разделе about_Quoting_Rules.

Type:	String
Aliases:	PSPath, LP
Position:	Named
Default value:	None
Accept pipeline input:	True
Accept wildcard characters:	False

-NoClobber

NoClobber предотвращает перезапись существующего файла и отображает сообщение о том, что файл уже существует. По умолчанию, если файл существует по указанному пути, Out-File он перезаписывается без предупреждения.

Type:	SwitchParameter
Aliases:	NoOverwrite
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-NoNewline

Указывает, что содержимое, записанное в файл, не заканчивается символом новой строки. Строковые представления входных объектов объединяются для формирования выходных данных. Пробелы или новые строки не вставляются между выходными строками. После последней выходной строки новая строка не добавляется.

Type:	SwitchParameter
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Показывает, что произойдет при запуске командлета. Командлет не выполняется.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Width

Указывает количество символов в каждой строке выходных данных. Все остальные знаки отсекаются, а не переносятся на следующую строку. Если этот параметр не используется, ширина определяется характеристиками узла. По умолчанию для консоли PowerShell используется 80 символов. Если вы хотите управлять шириной для всех вызовов , а также операторов Out-File перенаправления ( > и >> ), задайте $PSDefaultParameterValues[‘out-file:width’] = 2000 перед использованием Out-File .

Type:	Int32
Position:	Named
Default value:	None
Accept pipeline input:	False
Accept wildcard characters:	False

Входные данные

В этот командлет можно передать любой объект.

Выходные данные

None

Этот командлет не возвращает выходные данные.

Примечания

Входные объекты автоматически форматируются в окне терминала, но можно использовать Format-* командлет для явного управления форматированием выходных данных в файле. Например Get-Date | Format-List | Out-File out.txt .

Чтобы отправить выходные данные команды PowerShell в Out-File командлет, используйте конвейер . Кроме того, можно сохранить данные в переменной и использовать параметр InputObject для передачи данных в Out-File командлет .

Out-File сохраняет данные в файл, но не создает выходные объекты в конвейере.

Источник

If( Test-Path -Path $Path )
{
    Do-Stuff -Path $Path
}

PS:> Split-Path -Path 'c:userskevin.marquettedocuments'
c:userskevin.marquette

PS:> Split-Path -Path 'c:userskevin.marquettedocuments' -Leaf
documents

PS:> Join-Path -Path $env:temp -ChildPath testing
C:Userskevin.marqueteAppDataLocalTemptesting

Resolve-Path -Path 'c:users*documents'

Path
----
C:userskevin.marquetteDocuments
C:usersPublicDocuments

Get-Help Out-File
<#
SYNOPSIS
    Sends output to a file.
DESCRIPTION
    The Out-File cmdlet sends output to a file. You can use this cmdlet instead of the redirection operator (>) when you need to use its parameters.
#>

'This is some text' | Out-File -FilePath $Path

 Get-ChildItem |
     Select-Object Name, Length, LastWriteTime, Fullname |
     Out-File -FilePath $Path

Name
Length  LastWriteTime          FullName
----
------  -------------          --------
3A1BFD5A-88A6-487E-A790-93C661B9B904                 9/6/2016 10:38:54 AM   C:Userskevin.marqu...
acrord32_sbx                                         9/4/2016 10:18:18 AM   C:Userskevin.marqu...
TCD789A.tmp                                          9/8/2016 12:27:29 AM   C:Userskevin.marqu...

$data | Add-Content -Path $Path
Get-Content -Path $Path

Get-Content -Path $Path -Raw

$data | Export-CSV -Path $Path
Import-CSV -Path $Path

$data | Export-CSV -Path $Path -NoTypeInformation

Get-Date | Export-Clixml date.clicml
$date = Import-Clixml .date.clicml
$date.GetType()

IsPublic IsSerial Name                                     BaseType
-------- -------- ----                                     --------
True     True     DateTime                                 System.ValueType

<Objs Version="1.1.0.1" xmlns="http://schemas.microsoft.com/powershell/2004/04">
    <Obj RefId="0">
        <DT>2017-03-17T00:00:00.3522798-07:00</DT>
        <MS>
            <Obj N="DisplayHint" RefId="1">
                <TN RefId="0">
                    <T>Microsoft.PowerShell.Commands.DisplayHintType</T>
                    <T>System.Enum</T>
                    <T>System.ValueType</T>
                    <T>System.Object</T>
                </TN>
                <ToString>DateTime</ToString>
                <I32>2</I32>
            </Obj>
        </MS>
    </Obj>
</Objs>

$Data = @{
    Address = @{
        Street = '123 Elm'
        State  = 'California'
    }
}

$Data | ConvertTo-Json | Add-Content  -Path $Path
$NewData = Get-Content -Path $Path -Raw | ConvertFrom-Json
$NewData.Address.State

{
    "Address":  {
        "State":  "California",
        "Street":  "123 Elm"
    }
}

$dataset = @{}
Get-Content -Path $path -ReadCount 15 |
    Where-Object {$PSItem -match 'error'} |
    ForEach-Object {$dataset[$PSItem] += 1}

[System.IO.File]::ReadAllLines( ( Resolve-Path $Path ) )

[System.IO.File]::ReadAllText( ( Resolve-Path $Path ) )

try
{
    $stream = [System.IO.StreamWriter]::new( $Path )
    $data | ForEach-Object{ $stream.WriteLine( $_ ) }
}
finally
{
    $stream.close()
}

$Xml = [xml]"<r><data/></r>"
$Path = (join-path $pwd 'File.xml')
$Xml.Save($Path)

# Create default values for any parameter
# $PSDefaultParameterValues["Function:Parameter"]  = $value

# Set the default file encoding
$PSDefaultParameterValues["Out-File:Encoding"]    = "UTF8"
$PSDefaultParameterValues["Set-Content:Encoding"] = "UTF8"
$PSDefaultParameterValues["Add-Content:Encoding"] = "UTF8"
$PSDefaultParameterValues["Export-CSV:Encoding"]  = "UTF8"