Format-Custom

  • Riferimento
Modulo:
Microsoft.PowerShell.Utility

Usa una visualizzazione personalizzata per formattare l'output.

Sintassi

Format-Custom
      [[-Property] <Object[]>]
      [-Depth <Int32>]
      [-GroupBy <Object>]
      [-View <String>]
      [-ShowError]
      [-DisplayError]
      [-Force]
      [-Expand <String>]
      [-InputObject <PSObject>]
      [<CommonParameters>]

Descrizione

Il Format-Custom cmdlet formatta l'output di un comando come definito in una visualizzazione alternativa. Format-Custom è progettato per visualizzare le visualizzazioni che non sono solo tabelle o solo elenchi. È possibile usare le visualizzazioni definite in PowerShell oppure creare visualizzazioni personalizzate in un nuovo format.ps1xml file e usare il Update-FormatData cmdlet per aggiungerle a PowerShell.

Esempio

Esempio 1: Formattare l'output con una visualizzazione personalizzata

Get-Command Start-Transcript | Format-Custom -View MyView

Questo comando formatta le informazioni sul Start-Transcript cmdlet nel formato definito dalla visualizzazione MyView, una visualizzazione personalizzata creata dall'utente. Per eseguire correttamente questo comando, è prima necessario creare un nuovo file PS1XML, definire la visualizzazione MyView e quindi usare il Update-FormatData comando per aggiungere il file PS1XML a PowerShell.

Esempio 2: Formattare l'output con la visualizzazione predefinita

Get-Process Winlogon | Format-Custom

Questo comando formatta informazioni sul processo Winlogon in una visualizzazione personalizzata alternativa. Poiché il comando non usa il parametro View , Format-Custom usa una visualizzazione personalizzata predefinita per formattare i dati.

Esempio 3: Risoluzione degli errori di formato

Negli esempi seguenti vengono illustrati i risultati dell'aggiunta dei parametri DisplayError o ShowError con un'espressione.

PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -DisplayError

class DateTime
{
  DayOfWeek = Friday
   $_ / $null  = #ERR
}


PC /> Get-Date | Format-Custom DayOfWeek,{ $_ / $null } -ShowError

class DateTime
{
  DayOfWeek = Friday
   $_ / $null  =
}

Failed to evaluate expression " $_ / $null ".
+ CategoryInfo          : InvalidArgument: (12/21/2018 8:01:04 AM:PSObject) [], RuntimeException
+ FullyQualifiedErrorId : PSPropertyExpressionError

Parametri

-Depth

Specifica il numero di colonne nella visualizzazione.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayError

Visualizza gli errori nella riga di comando. Questo parametro viene usato raramente, ma può essere usato come supporto per il debug quando si formattano espressioni in un Format-Custom comando e le espressioni non sembrano funzionare.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Expand

Formatta l'oggetto raccolta, nonché gli oggetti nella raccolta. Questo parametro è progettato per formattare gli oggetti che supportano l'interfaccia System.Collections.ICollection . Il valore predefinito è EnumOnly.

I valori validi sono:

  • EnumOnly: visualizza le proprietà degli oggetti nell'insieme.
  • CoreOnly: visualizza le proprietà dell'oggetto raccolta.
  • Entrambi: visualizza le proprietà dell'oggetto insieme e gli oggetti nell'insieme.
Type:String
Accepted values:CoreOnly, EnumOnly, Both
Position:Named
Default value:EnumOnly
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Indica al cmdlet di visualizzare tutte le informazioni sull'errore. Usare con i parametri DisplayError o ShowError . Per impostazione predefinita, quando un oggetto errore viene scritto nei flussi di errore o di visualizzazione, vengono visualizzate solo alcune informazioni sull'errore.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-GroupBy

Formatta l'output in gruppi in base a una proprietà o un valore condiviso. Immettere un'espressione o una proprietà dell'output.

Il valore del parametro GroupBy può essere una nuova proprietà calcolata. La proprietà calcolata può essere un blocco di script o una tabella hash. Le coppie chiave-valore valide sono:

  • Nome (o Etichetta) - <string>
  • Espressione - <string> o <script block>
  • Formatstring- <string>

Per altre informazioni, vedere about_Calculated_Properties.

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifica gli oggetti da formattare. Immettere una variabile che contiene gli oggetti oppure digitare un comando o un'espressione che ottiene gli oggetti.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Property

Specifica le proprietà dell'oggetto che vengono presentate nella visualizzazione e l'ordine in cui appaiono. I caratteri jolly sono consentiti.

Se si omette questo parametro, le proprietà presentate nella visualizzazione dipendono dall'oggetto visualizzato. 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. La proprietà calcolata può essere un blocco di script o una tabella hash. Le coppie chiave-valore valide sono:

  • Espressione - <string> o <script block>
  • Profondità- <int32>

Per altre informazioni, vedere about_Calculated_Properties.

Type:Object[]
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-ShowError

Invia errori tramite la pipeline. Questo parametro viene usato raramente, ma può essere usato come supporto per il debug quando si formattano espressioni in un Format-Custom comando e le espressioni non sembrano funzionare.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-View

Specifica il nome di un formato o di una vista alternativa. Se si omette questo parametro, Format-Custom usa una visualizzazione personalizzata predefinita. Non è possibile utilizzare i parametri Property e View nello stesso comando.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Input

PSObject

È possibile inviare tramite pipe qualsiasi oggetto a questo cmdlet.

Output

Microsoft.PowerShell.Commands.Internal.Format

Questo cmdlet restituisce gli oggetti di formato che rappresentano la visualizzazione.

Note

PowerShell include gli alias seguenti per Format-Custom:

  • Tutte le piattaforme:
    • fc

Format-Custom è progettato per visualizzare le visualizzazioni che non sono solo tabelle o solo elenchi. Per visualizzare una vista tabella alternativa, utilizzare Format-Table. Per visualizzare una visualizzazione elenco alternativa, utilizzare Format-List.

Il parametro GroupBy presuppone che gli oggetti siano ordinati. Prima di usare Format-Custom per raggruppare gli oggetti, usare Sort-Object per ordinarli.