Utilizza una visualizzazione personalizzata per formattare l'output.
Sintassi
Format-Custom [[-Property] <Object[]>] [-Depth <int>] [-DisplayError] [-Expand <string>] [-Force] [-GroupBy <Object>] [-InputObject <psobject>] [-ShowError] [-View <string>] [<CommonParameters>]
Descrizione
Il cmdlet Format-Custom formatta l'output di un comando secondo la definizione di una visualizzazione alternativa. Format-Custom è progettato in modo da restituire visualizzazioni che non corrispondono solo a tabelle o a elenchi. È possibile utilizzare le visualizzazioni definite nei file *format.PS1XML della directory Windows PowerShell oppure creare visualizzazioni personalizzate in nuovi file PS1XML e utilizzare il cmdlet Update-FormatData per aggiungerle a Windows PowerShell.
Parametri
-Depth <int>
Specifica il numero di colonne della visualizzazione.
|
Obbligatorio? |
false |
|
Posizione? |
named |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
false |
|
Accettare caratteri jolly? |
false |
-DisplayError
Visualizza gli errori sulla riga di comando.
|
Obbligatorio? |
false |
|
Posizione? |
named |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
false |
|
Accettare caratteri jolly? |
false |
-Expand <string>
Formatta l'oggetto insieme, nonché gli oggetti inclusi nell'insieme. Questo parametro è progettato in modo da formattare oggetti che supportano l'interfaccia ICollection (System.Collections). Il valore predefinito è EnumOnly.
I valori validi sono:
-- EnumOnly: visualizza le proprietà degli oggetti presenti nella raccolta.
-- CoreOnly: visualizza le proprietà dell'oggetto raccolta.
-- Both: visualizza le proprietà dell'oggetto raccolta e degli oggetti inclusi nella raccolta.
|
Obbligatorio? |
false |
|
Posizione? |
named |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
false |
|
Accettare caratteri jolly? |
false |
-Force
Indica al cmdlet di visualizzare tutte le informazioni sull'errore. Utilizzare con il parametro DisplayError o ShowError. Per impostazione predefinita, quando un oggetto errore viene scritto nei flussi di errore o di visualizzazione, solo una parte delle informazioni sull'errore viene visualizzata.
|
Obbligatorio? |
false |
|
Posizione? |
named |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
false |
|
Accettare caratteri jolly? |
false |
-GroupBy <Object>
Formatta l'output in gruppi basati su un valore o una proprietà condivisa. Immettere un'espressione o una proprietà dell'output.
Il valore del parametro GroupBy può essere una nuova proprietà calcolata. Per creare una proprietà calcolata, utilizzare una tabella hash. Le chiavi valide sono le seguenti:
-- Name (o Label) <stringa>
-- Expression <stringa> o <blocco di script>
-- FormatString <stringa>
|
Obbligatorio? |
false |
|
Posizione? |
named |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
false |
|
Accettare caratteri jolly? |
false |
-InputObject <psobject>
Specifica gli oggetti da formattare. 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 |
-Property <Object[]>
Specifica le proprietà dell'oggetto incluse nella visualizzazione e l'ordine in cui vengono visualizzate. È consentito l'utilizzo di caratteri jolly.
Se questo parametro viene omesso, le proprietà incluse nella visualizzazione dipenderanno dall'oggetto da visualizzare. Il nome del parametro ("Property") è facoltativo. Non è possibile utilizzare i parametri Property e View nello stesso comando.
Il valore del parametro Property può essere una nuova proprietà calcolata. Per creare una proprietà calcolata, utilizzare una tabella hash. Le chiavi valide sono le seguenti:
-- Expression <stringa> o <blocco di script>
-- Depth <int32>
|
Obbligatorio? |
false |
|
Posizione? |
1 |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
false |
|
Accettare caratteri jolly? |
false |
-ShowError
Invia gli errori attraverso la pipeline.
|
Obbligatorio? |
false |
|
Posizione? |
named |
|
Valore predefinito |
|
|
Accettare input da pipeline? |
false |
|
Accettare caratteri jolly? |
false |
-View <string>
Specifica il nome di un formato o di una visualizzazione alternativa. Se si omette questo parametro, Format-Custom utilizza una visualizzazione personalizzata predefinita. Non è possibile utilizzare i parametri Property e View nello stesso comando.
|
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 qualsiasi oggetto a Format-Custom. |
|
Output |
Microsoft.PowerShell.Commands.Internal.Format Format-Custom restituisce gli oggetti formato che rappresentano la visualizzazione. |
Note
Format-Custom è progettato in modo da restituire visualizzazioni che non corrispondono solo a tabelle o a elenchi. Per ottenere una visualizzazione tabella alternativa, utilizzare Format-Table. Per ottenere una visualizzazione elenco alternativa, utilizzare Format-List.
È inoltre possibile fare riferimento a Format-Custom tramite il relativo alias predefinito "fc". Per ulteriori informazioni, vedere about_Aliases.
Per il parametro GroupBy si presuppone che gli oggetti siano ordinati. Prima di utilizzare Format-Custom per raggruppare gli oggetti, ordinarli con Sort-Object.
Esempio 1
C:\PS>get-command start-transcript | format-custom -view MyView Descrizione ----------- Tramite questo comando le informazioni sul cmdlet Start-Transcript vengono formattate nel formato definito dalla visualizzazione personalizzata MyView, creata dall'utente. Per la corretta esecuzione di questo comando, è necessario creare prima un nuovo file PS1XML, definire la visualizzazione MyView, quindi utilizzare il comando Update-FormatData per aggiungere il file PS1XML a Windows PowerShell.
Esempio 2
C:\PS>get-process Winlogon | format-custom Descrizione ----------- Tramite questo comando le informazioni sul processo Winlogon verranno formattate in una visualizzazione personalizzata alternativa. Poiché per il comando non viene utilizzato il parametro View, Format-Custom utilizza una visualizzazione personalizzata predefinita per la formattazione dei dati.