Invia gli oggetti all'host come serie di stringhe.

Sintassi

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

Descrizione

Il cmdlet Out-String consente di convertire gli oggetti gestiti da Windows PowerShell in una matrice di stringhe. Per impostazione predefinita, Out-String accumula le stringhe e le restituisce in un'unica stringa. È tuttavia possibile utilizzare il parametro stream per indicare a Out-String di restituire una stringa alla volta. Questo cmdlet consente di gestire e modificare l'output delle stringhe in modo simile alle shell tradizionali, in cui tuttavia la modifica degli oggetti risulta meno efficiente.

Parametri

-InputObject <psobject>

Specifica gli oggetti da scrivere in una stringa. Immettere una variabile contenente gli oggetti oppure digitare un comando o un'espressione che consente di ottenere gli oggetti.

Obbligatorio?

false

Posizione?

named

Valore predefinito

Accettare input da pipeline?

true (ByValue)

Accettare caratteri jolly?

false

-Stream

Invia separatamente le stringhe per ciascun oggetto. Per impostazione predefinita, le stringhe relative a ciascun oggetto vengono accumulate e inviate in un'unica stringa.

Obbligatorio?

false

Posizione?

named

Valore predefinito

Accettare input da pipeline?

false

Accettare caratteri jolly?

false

-Width <int>

Specifica il numero di caratteri di ogni riga di output. Eventuali caratteri aggiuntivi vengono troncati e non portati a capo. Se si omette questo parametro, la larghezza verrà determinata dalle caratteristiche dell'host. Il valore predefinito per l'host di PowerShell.exe è 80 (caratteri).

Obbligatorio?

false

Posizione?

named

Valore predefinito

Accettare input da pipeline?

false

Accettare caratteri jolly?

false

<CommonParameters>

Questo cmdlet supporta i parametri comuni -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Per ulteriori informazioni, vedere about_Commonparameters.

Input e output

Il tipo di input è il tipo degli oggetti che è possibile reindirizzare al cmdlet. Il tipo restituito è il tipo degli oggetti restituiti dal cmdlet.

Input

System.Management.Automation.PSObject

È possibile reindirizzare oggetti a Out-String.

Output

System.String

Out-String restituisce la stringa creata dall'oggetto di input.

Note

I cmdlet che contengono il verbo Out (cmdlet Out) non consentono di formattare gli oggetti ma solo di eseguirne il rendering e di inviarli alla destinazione di visualizzazione specificata. Un oggetto non formattato inviato a un cmdlet di tipo Out verrà inviato a un cmdlet di formattazione prima di eseguirne il rendering.

Con i cmdlet di tipo Out non sono disponibili parametri per nomi o percorsi di file. Per inviare i dati a un cmdlet Out, utilizzare un operatore pipeline (|) per inviare l'output di un comando di Windows PowerShell al cmdlet. È inoltre possibile archiviare i dati in una variabile e utilizzare il parametro InputObject per passare i dati al cmdlet. Per ulteriori informazioni, vedere gli esempi.

Esempio 1

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

Descrizione
-----------
Tramite questo comando il contenuto del file Testfile2.txt verrà inviato alla console come singola stringa. Verrà utilizzato il cmdlet Get-Content per ottenere il contenuto del file. Verrà quindi utilizzato l'operatore pipeline (|) per inviare il contenuto a Out-String, che lo invierà alla console come una singola stringa.






Esempio 2

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

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

Descrizione
-----------
Tramite questi comandi verranno ottenute le impostazioni internazionali per l'utente corrente. I dati ottenuti verranno quindi convertiti in stringhe. Nel primo comando verrà utilizzato il cmdlet Get-Culture per ottenere le impostazioni internazionali. Verrà quindi utilizzato l'operatore pipeline (|) per inviare il risultato al cmdlet Select-Object, che selezionerà tutte le proprietà (*) dell'oggetto impostazioni cultura recuperato da Get-Culture. I risultati verranno infine archiviati nella variabile $c.

Nel secondo comando verrà utilizzato Out-String per convertire l'oggetto CultureInfo in una serie di stringhe, una per ciascuna proprietà. Verrà utilizzato il parametro InputObject per passare la variabile $c a Out-String. Il parametro width è impostato su 100 caratteri per riga per evitare il troncamento.






Esempio 3

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

Descrizione
-----------
Tramite questo comando verranno visualizzati gli alias che includono la frase "Get-Command". Verrà utilizzato il cmdlet Get-Alias per ottenere un set di oggetti AliasInfo, uno per ciascun alias della sessione corrente. In questo esempio viene illustrata la differenza tra la gestione di oggetti e la gestione di stringhe.

Verrà quindi utilizzato l'operatore pipeline (|) per inviare l'output di Get-Alias a Out-String, che convertirà gli oggetti in una serie di stringhe. Per inviare ciascuna stringa singolarmente, anziché concatenarle in una singola stringa, verrà utilizzato il parametro Stream. Verrà quindi utilizzato un altro operatore pipeline per inviare le stringhe a Select-String, che selezionerà quelle che includono la frase "Get-Command" in qualsiasi posizione. 

Se si omette il parametro Stream, verranno visualizzati tutti gli alias, perchè Select-String troverà "Get-Command" nella singola stringa restituita da Out-String e il formattatore visualizzerà le stringhe come tabella.






Vedere anche




Argomenti della Guida