Отправляет объекты основному приложению в виде последовательности строк.

Синтаксис

Out-String [-InputObject <psobject>] [-Stream] [-Width <int>] [<CommonParameters>]

Описание

Командлет Out-String преобразует объекты, которыми управляет Windows PowerShell, в массив строк. По умолчанию командлет Out-String накапливает строки и возвращает их как одну строку, однако с помощью параметра stream можно задать вывод Out-String по одной строке за раз. Этот командлет позволяет управлять строковым выводом и проводить в нем поиск, как и при работе с традиционными оболочками, если использование объектов менее удобно.

Параметры

-InputObject <psobject>

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

Обязательно?	false
Позиция?	named
Значение по умолчанию
Принимать входные данные из конвейера?	true (ByValue)
Принимать подстановочные знаки?	false

-Stream

Передает строки для каждого объекта отдельно. По умолчанию строки для каждого объекта накапливаются и отправляются в виде одной строки.

Обязательно?	false
Позиция?	named
Значение по умолчанию
Принимать входные данные из конвейера?	false
Принимать подстановочные знаки?	false

-Width <int>

Указывает число знаков в каждой выходной строке. Все остальные знаки усекаются, а не переносятся на следующую строку. Если данный параметр опущен, ширина определяется характеристиками основного приложения. Значение по умолчанию для основного приложения PowerShell.exe равно 80 (знаков).

Обязательно?	false
Позиция?	named
Значение по умолчанию
Принимать входные данные из конвейера?	false
Принимать подстановочные знаки?	false

<CommonParameters>

Данный командлет поддерживает общие параметры -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer и -OutVariable. Дополнительные сведения см. в разделе about_Commonparameters.

Ввод и вывод

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

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

System.Management.Automation.PSObject

Объекты можно передать командлету Out-String по конвейеру.

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

System.String

Командлет Out-String возвращает строку, которую создает из объекта ввода.

Примечания

Командлеты, содержащие команду Out (командлеты Out) не форматируют объекты, а только обрабатывают их и отправляют в указанное назначение для отображения. Если передать неформатированный объект в командлет Out, он перед обработкой отправит его в форматирующий командлет.

Командлеты Out не содержат параметров для указания имен или путей. Для передачи данных командлету Out используйте оператор конвейера (|), чтобы передать выходные данные команды Windows PowerShell командлету. Также можно хранить данные в переменной и использовать параметр InputObject для передачи данных в командлет. Дополнительные сведения см. в примерах.

Пример 1

C:\PS>get-content C:\test1\testfile2.txt | out-string

Описание
-----------
Эта команда отправляет содержимое файла Testfile2.txt на консоль в виде одной строки. Для получения содержимого файла в этой команде используется командлет Get-Content. Оператор конвейера (|) передает содержимое файла командлету Out-String, который отправляет его на консоль в виде строки.

Пример 2

C:\PS>$c = get-culture | select-object *

C:\PS> out-string -inputobject $c -width 100

Описание
-----------
Эти команды получают региональные параметры, заданные для текущего пользователя, и преобразуют полученные данные в строки. Первая команда получает региональные параметры с помощью командлета Get-Culture. Оператор конвейера (|) отправляет результат командлету Select-Object, который выбирает все свойства (*) объекта региональных параметров, возвращенного командлетом Get-Culture. Затем результаты сохраняются в переменной $c.

Вторая команда с помощью командлета Out-String преобразует объект CultureInfo в последовательность строк (по одной для каждого свойства). Для передачи значения переменной $c командлету Out-String используется параметр InputObject. Параметр width имеет значение 100 знаков на строку, что предотвращает обрезку строк.

Пример 3

C:\PS>get-alias | out-string -stream | select-string "Get-Command"

Описание
-----------
Эта команда отображает псевдонимы, включающие фразу "Get-Command". Командлет Get-Alias используется ею для получения набора объектов AliasInfo (каждый представляет один псевдоним, определенный в оболочке). Этот пример демонстрирует различие между работой с объектами и работой со строками.

Оператор конвейера (|) отправляет вывод командлета Get-Alias командлету Out-String, который преобразует объекты в набор строк. Параметр Stream указывает, что вывод должен быть отправлен как отдельные строки, а не как одна объединенная строка. Еде один оператор конвейера отправляет строки командлету Select-String, который выбирает строки, содержащие слова "Get-Command". 

Если опустить параметр Stream, эта команда отобразит все псевдонимы, потому что командлет Select-String найдет слова "Get-Command" в единственной строке, возвращенной командлетом Out-String, а механизм форматирования отобразит эту строку в виде таблицы.

Out-String