Sdílet prostřednictvím

Out-String

  • Reference
Modul:
Microsoft.PowerShell.Utility

Odesílá objekty hostiteli jako řadu řetězců.

Syntaxe

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

Description

Rutina Out-String převede objekty, které Windows PowerShell spravuje, na pole řetězců. Ve výchozím nastavení Out-String hromadí řetězce a vrátí je jako jeden řetězec, ale můžete použít parametr Stream k nasměrování Out-String k vrácení jednoho řetězce najednou. Tato rutina umožňuje prohledávat a manipulovat s výstupem řetězce stejně jako v tradičních prostředích, když je manipulace s objekty méně pohodlná.

Příklady

Příklad 1: Výstupní text do konzoly jako řetězec

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

Tento příkaz odešle obsah souboru Testfile2.txt do konzoly jako jeden řetězec. K získání obsahu souboru používá rutinu Get-Content. Operátor kanálu (|) odešle obsah do Out-String, který odešle obsah do konzoly jako řetězec.

Příklad 2: Získání aktuální jazykové verze a převod dat na řetězce

První příkaz použije rutinu Get-Culture k získání místního nastavení. Operátor kanálu (|) odešle výsledek do rutiny Select-Object, která vybere všechny vlastnosti (*) objektu jazykové verze, který Get-Culture vrácen. Příkaz pak uloží výsledky do proměnné $C.

Druhý příkaz používá rutinu Out-String k převodu objektu CultureInfo na řadu řetězců (jeden řetězec pro každou vlastnost). Pomocí parametru InputObject předává proměnnou $COut-String. Parametr Width je nastaven na 100 znaků na řádek, aby se zabránilo zkrácení.

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

Tyto příkazy získají místní nastavení pro aktuálního uživatele a převedou data na řetězce.

Příklad 3: Práce s objekty

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

Tento příklad ukazuje rozdíl mezi prací s objekty a prací s řetězci. Příkaz zobrazí aliasy, které obsahují frázi Get-Command. Pomocí rutiny Get-Alias získá sadu objektů AliasInfo (jeden pro každý alias v aktuální relaci).

Operátor kanálu (|) odešle výstup rutiny Get-Alias do rutiny Out-String, která převede objekty na řadu řetězců. Používá parametr StreamOut-String k individuálnímu odeslání každého řetězce místo jejich zřetězení do jednoho řetězce. Jiný operátor kanálu odešle řetězce do rutiny Select-String, která vybere řetězce, které obsahují příkaz Get-Command kdekoli v řetězci.

Pokud vynecháte parametr Stream, příkaz zobrazí všechny aliasy, protože Select-String v jednom řetězci, který Out-String vrátí, najde příkaz Get-Command a formátovací modul zobrazí řetězec jako tabulku.

Parametry

-InputObject

Určuje objekty, které mají být zapsány do řetězce. Zadejte proměnnou, která obsahuje objekty, nebo zadejte příkaz nebo výraz, který objekty získá.

Typ:PSObject
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Stream

Označuje, že rutina odesílá řetězce pro každý objekt samostatně. Ve výchozím nastavení se řetězce pro každý objekt shromažďují a odesílají jako jeden řetězec.

Pokud chcete použít parametr Stream, zadejte -Stream nebo jeho alias ost.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Width

Určuje počet znaků v každém řádku výstupu. Všechny další znaky jsou zkráceny, nejsou zabaleny. Parametr Width se vztahuje pouze na objekty, které jsou formátované. Pokud tento parametr vynecháte, šířka je určena vlastnostmi hostitelského programu. Výchozí hodnota konzoly Windows PowerShellu je 80 (znaků).

Typ:Int32
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

PSObject

Objekty můžete pipetovat do Out-String.

Výstupy

String

Out-String vrátí řetězec, který vytvoří ze vstupního objektu.

Poznámky

  • Rutiny, které obsahují Out sloveso, které neformátují objekty; jenom je vykreslují a posílají je do zadaného cíle zobrazení. Pokud do rutiny Out odešlete neformátovaný objekt, rutina ho před vykreslením odešle do rutiny formátování.
  • Rutiny Out nemají parametry, které přebírají názvy nebo cesty k souborům. Pokud chcete odesílat data do rutiny Out, použijte operátor kanálu (|) k odeslání výstupu příkazu Prostředí Windows PowerShell do rutiny. Data můžete také uložit do proměnné a pomocí parametru InputObject předat data rutině.