Поделиться через

Out-String

  • Ссылка
Модуль:
Microsoft.PowerShell.Utility

Выводит входные объекты в виде строки.

Синтаксис

Out-String
   [-Width <Int32>]
   [-NoNewline]
   [-InputObject <PSObject>]
   [<CommonParameters>]
Out-String
   [-Stream]
   [-Width <Int32>]
   [-InputObject <PSObject>]
   [<CommonParameters>]

Описание

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

PowerShell также добавляет OSS функцию, которая вызывается Out-String -Stream как короткий способ использования Out-String в конвейере.

Примеры

Пример 1. Получение текущего языка и региональных параметров и преобразование данных в строки

Этот пример получает региональные параметры для текущего пользователя и преобразует данные объекта в строки.

$C = Get-Culture | Select-Object -Property *
Out-String -InputObject $C -Width 100

Parent                         : en
LCID                           : 1033
KeyboardLayoutId               : 1033
Name                           : en-US
IetfLanguageTag                : en-US
DisplayName                    : English (United States)
NativeName                     : English (United States)
EnglishName                    : English (United States)
TwoLetterISOLanguageName       : en
ThreeLetterISOLanguageName     : eng
ThreeLetterWindowsLanguageName : ENU
CompareInfo                    : CompareInfo - en-US
TextInfo                       : TextInfo - en-US
IsNeutralCulture               : False
CultureTypes                   : SpecificCultures, InstalledWin32Cultures, FrameworkCultures
NumberFormat                   : System.Globalization.NumberFormatInfo
DateTimeFormat                 : System.Globalization.DateTimeFormatInfo
Calendar                       : System.Globalization.GregorianCalendar
OptionalCalendars              : {System.Globalization.GregorianCalendar,
                                 System.Globalization.GregorianCalendar}
UseUserOverride                : True
IsReadOnly                     : False

Переменная $C сохраняет объект Selected.System.Globalization.CultureInfo . Объект является результатом отправки выходных Get-Culture данных по конвейеру Select-Object. Параметр Property использует подстановочный знак звездочки (*) для указания всех свойств, содержащихся в объекте.

Out-Stringиспользует параметр InputObject для указания объекта CultureInfo, хранящегося в переменной$C. Объекты, в $C которых находятся, преобразуются в строку.

Примечание.

Чтобы просмотреть Out-String массив, сохраните выходные данные в переменной и используйте индекс массива для просмотра элементов. Дополнительные сведения об индексе массива см. в about_Arrays.

$str = Out-String -InputObject $C -Width 100

Пример 2. Работа с объектами

В этом примере показано различие между работой с объектами и работой со строками. Команда отображает псевдоним, содержащий текстовый gcm, псевдоним для Get-Command.

Get-Alias | Out-String -Stream | Select-String -Pattern "gcm"

Alias           gcm -> Get-Command

Get-Aliasполучает объекты System.Management.Automation.AliasInfo, по одному для каждого псевдонима и отправляет объекты вниз по конвейеру. Out-Stringиспользует параметр Stream для преобразования каждого объекта в строку, а не объединения всех объектов в одну строку. Объекты System.String отправляются вниз конвейера и Select-String используют параметр Pattern для поиска совпадений для текстового gcm.

Примечание.

Если параметр Stream не указан, команда отображает все псевдонимы, так как Select-String находит текст gcm в одной строке, которая Out-String возвращается.

Пример 3. Используйте параметр Width для предотвращения усечения.

Хотя большинство выходных данных упаковывается в следующую строку, существуют сценарии, в которых выходные данные Out-String усечены системой форматирования перед передачей Out-Stringв. Вы можете избежать усечения с помощью параметра Width .

PS> @{TestKey = ('x' * 200)} | Out-String
Name                           Value
----                           -----
TestKey                        xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx...

PS> @{TestKey = ('x' * 200)} | Out-String -Width 250

Name                           Value
----                           -----
TestKey                        xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Параметры

-InputObject

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

Тип:PSObject
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-NoNewline

Удаляет все новые строки из выходных данных, созданных методом форматирования PowerShell. Сохраняются новые строки, которые являются частью строковых объектов.

Этот параметр появился в PowerShell 6.0.

Тип:SwitchParameter
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Stream

По умолчанию выводит одну строку, отформатированную в консоли, Out-String включая пустые заголовки или конечные новые строки. Параметр Stream позволяет Out-String выводить каждую строку по одной. Единственным исключением из этого являются многостроковые строки. В этом случае Out-String по-прежнему будет выводить строку в виде одной многострочного строки.

Тип:SwitchParameter
Position:Named
Default value:False
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Width

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

Тип:Int32
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

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

PSObject

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

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

String

Этот командлет возвращает строку, созданную из входного объекта.

Примечания

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

PowerShell 7.2 добавила возможность управлять отображением escape-последовательностей ANSI. Выходные данные, украшенные ANSI, которые Out-String передаются, можно изменить на основе параметра $PSStyle.OutputRendering свойства. Дополнительные сведения см. в about_ANSI_Terminals.