Udostępnij za pomocą

Out-String

Moduł:
Microsoft.PowerShell.Utility Module

Wysyła obiekty do hosta jako serię ciągów.

Składnia

Default (domyślnie) 

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

Opis

Polecenie cmdlet Out-String konwertuje obiekty zarządzane przez program Windows PowerShell na tablicę ciągów. Domyślnie Out-String gromadzi ciągi i zwraca je jako pojedynczy ciąg, ale możesz użyć parametru Stream, aby skierować Out-String, aby zwrócić jeden ciąg naraz. To polecenie cmdlet umożliwia wyszukiwanie i manipulowanie danymi wyjściowymi ciągów, tak jak w tradycyjnych powłokach, gdy manipulowanie obiektami jest mniej wygodne.

Przykłady

Przykład 1: Wyprowadzanie tekstu do konsoli jako ciągu

PS C:\> Get-Content C:\test1\testfile2.txt | Out-String

To polecenie wysyła zawartość pliku Testfile2.txt do konsoli jako pojedynczy ciąg. Używa on polecenia cmdlet Get-Content w celu pobrania zawartości pliku. Operator potoku (|) wysyła zawartość do Out-String, która wysyła zawartość do konsoli jako ciąg.

Przykład 2: Pobierz bieżącą kulturę i przekonwertuj dane na ciągi

Pierwsze polecenie używa polecenia cmdlet Get-Culture w celu pobrania ustawień regionalnych. Operator potoku (|) wysyła wynik do polecenia cmdlet Select-Object, które wybiera wszystkie właściwości (*) obiektu kultury, który Get-Culture zwrócony. Następnie polecenie przechowuje wyniki w zmiennej $C.

Drugie polecenie używa polecenia cmdlet Out-String, aby przekonwertować obiekt CultureInfo na serię ciągów (jeden ciąg dla każdej właściwości). Używa on parametru InputObject , aby przekazać zmienną do . Parametr Width jest ustawiony na 100 znaków na wiersz, aby zapobiec obcinaniu.

PS C:\> $C = Get-Culture | Select-Object *
PS C:\> Out-String -InputObject $C -Width 100

Te polecenia pobierają ustawienia regionalne bieżącego użytkownika i konwertują dane na ciągi.

Przykład 3: Praca z obiektami

PS C:\> Get-Alias | Out-String -Stream | Select-String "Get-Command"

W tym przykładzie pokazano różnicę między pracą z obiektami i pracą z ciągami. Polecenie wyświetla aliasy zawierające frazę "Get-Command". Używa polecenia cmdlet Get-Alias, aby uzyskać zestaw obiektów AliasInfo (jeden dla każdego aliasu w bieżącej sesji).

Operator potoku (|) wysyła dane wyjściowe polecenia cmdlet Get-Alias do polecenia cmdlet Out-String, które konwertuje obiekty na serię ciągów. Używa Stream parametru Out-String do wysyłania poszczególnych ciągów zamiast łączenia ich w jeden ciąg. Inny operator potoku wysyła ciągi do polecenia cmdlet Select-String, które wybiera ciągi zawierające ciągi "Get-Command" w dowolnym miejscu w ciągu.

Jeśli pominięto parametr Stream, polecenie wyświetla wszystkie aliasy, ponieważ Select-String znajduje ciąg "Get-Command" w jednym ciągu, który Out-String zwraca, a formatator wyświetla ciąg jako tabelę.

Parametry

-InputObject

Określa obiekty, które mają być zapisywane w ciągu. Wprowadź zmienną zawierającą obiekty lub wpisz polecenie lub wyrażenie, które pobiera obiekty.

Właściwości parametru

Typ:PSObject
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Stream

Wskazuje, że polecenie cmdlet wysyła ciągi dla każdego obiektu oddzielnie. Domyślnie ciągi dla każdego obiektu są gromadzone i wysyłane jako pojedynczy ciąg.

Aby użyć parametru Stream, wpisz lub jego alias, .

Właściwości parametru

Typ:SwitchParameter
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Width

Określa liczbę znaków w każdym wierszu danych wyjściowych. Wszelkie dodatkowe znaki są obcinane, nie owinięte. Parametr Width dotyczy tylko obiektów sformatowanych. Jeśli pominięto ten parametr, szerokość jest określana przez cechy programu hosta. Wartość domyślna konsoli programu Windows PowerShell to 80 (znaki).

Właściwości parametru

Typ:Int32
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

PSObject

Obiekty można potokować do Out-String.

Dane wyjściowe

String

Out-String zwraca ciąg tworzony na podstawie obiektu wejściowego.

Uwagi

  • Polecenia cmdlet zawierające czasownik out, które nie formatują obiektów; po prostu je renderują i wysyłają je do określonego miejsca docelowego wyświetlania. Jeśli wysyłasz niesformatowany obiekt do polecenia cmdlet out, polecenie cmdlet wysyła go do polecenia cmdlet formatowania przed jego renderowaniem.
  • Polecenia cmdlet out nie mają parametrów, które przyjmują nazwy ani ścieżki plików. Aby wysłać dane do polecenia cmdlet out, użyj operatora potoku (|), aby wysłać dane wyjściowe polecenia programu Windows PowerShell do polecenia cmdlet. Możesz również przechowywać dane w zmiennej i użyć parametru InputObject, aby przekazać dane do polecenia cmdlet.