次の方法で共有

Get-FormatData

  • リファレンス
モジュール:
Microsoft.PowerShell.Utility

現在のセッションの書式設定データを取得します。

構文

Get-FormatData
   [[-TypeName] <String[]>]
   [-PowerShellVersion <Version>]
   [<CommonParameters>]

説明

Get-FormatData コマンドレットは、現在のセッションの書式設定データを取得します。

セッションの書式設定データには、$PSHOME ディレクトリ内の書式設定ファイルなどのFormat.ps1xmlフォーマット ファイルの書式設定、セッションにインポートするモジュールのデータの書式設定、Import-PSSession コマンドレットを使用してセッションにインポートするコマンドのデータの書式設定が含まれます。

このコマンドレットを使用すると、書式設定データを確認できます。 その後、 Export-FormatData コマンドレットを使用して、オブジェクトをシリアル化し、XML に変換して、 Format.ps1xml ファイルに保存できます。

PowerShell でのファイルの書式設定の詳細については、「 about_Format.ps1xml」を参照してください。

例

例 1: すべての書式設定データを取得する

この例では、セッション内のすべての書式設定データを取得します。

Get-FormatData

例 2: 型名で書式設定データを取得する

次の使用例は、名前が System.Management.Automation.Cmd で始まる書式設定データ項目を取得します。

Get-FormatData -TypeName 'System.Management.Automation.Cmd*'

例 3: 書式設定データ オブジェクトを調べる

この例では、書式設定データ オブジェクトを取得し、そのプロパティを確認する方法を示します。

$F = Get-FormatData -TypeName 'System.Management.Automation.Cmd*'
$F

TypeName        FormatViewDefinition
--------        --------------------
HelpInfoShort   {help , TableControl}

$F.FormatViewDefinition[0].control

Headers          : {System.Management.Automation.TableControlColumnHeader,
                   System.Management.Automation.TableControlColumnHeader,
                   System.Management.Automation.TableControlColumnHeader,
                   System.Management.Automation.TableControlColumnHeader}
Rows             : {System.Management.Automation.TableControlRow}
AutoSize         : False
HideTableHeaders : False
GroupBy          :
OutOfBand        : False

$F.FormatViewDefinition[0].control.Headers

Label       Alignment Width
-----       --------- -----
CommandType Undefined    15
Name        Undefined    50
Version     Undefined    10
Source      Undefined     0

例 4: 書式設定データを取得してエクスポートする

この例では、 Get-FormatData と Export-FormatData を使用して、モジュールによって追加された書式設定データをエクスポートする方法を示します。

$A = Get-FormatData
Import-Module bitstransfer
$B = Get-FormatData
Compare-Object $A $B

InputObject                                                SideIndicator
-----------                                                -------------
Microsoft.BackgroundIntelligentTransfer.Management.BitsJob =>

Get-FormatData *bits* | Export-FormatData -FilePath c:\test\bits.format.ps1xml
Get-Content c:\test\bits.format.ps1xml

<?xml version="1.0" encoding="utf-8"?><Configuration><ViewDefinitions>
<View><Name>Microsoft.BackgroundIntelligentTransfer.Management.BitsJob</Name>
...

最初の 4 つのコマンドでは、 Get-FormatData、 Import-Module、および Compare-Object コマンドレットを使用して、 BitsTransfer モジュールがセッションに追加する形式の種類を識別します。

5 番目のコマンドでは、 Get-FormatData コマンドレットを使用して、 BitsTransfer モジュールが追加する形式の種類を取得します。 パイプライン演算子 (|) を使用してフォーマット型オブジェクトを Export-FormatData コマンドレットに送信し、XML に変換して指定した format.ps1xml ファイルに保存します。

最後のコマンドは、 format.ps1xml ファイルの内容の抜粋を示しています。

例 5: 指定したバージョンの PowerShell に基づいて書式設定データを取得する

この例では、 Get-FormatData を使用して、指定した TypeName および PowerShell バージョンの書式データを取得する方法を示します。

Get-FormatData -TypeName 'Microsoft.Powershell.Utility.FileHash' -PowerShellVersion $PSVersionTable.PSVersion

TypeNames                               FormatViewDefinition
---------                               --------------------
{Microsoft.Powershell.Utility.FileHash} {Microsoft.Powershell.Utility.FileHash}

パラメーター

-PowerShellVersion

このコマンドレットが書式設定データ用に取得する PowerShell のバージョンを指定します。 ピリオドで区切られた 2 桁の数字を入力します。

このパラメーターは、以前のバージョンの PowerShell を実行しているコンピューターをリモート処理するときの互換性を向上させるために、PowerShell 5.1 で追加されました。

型:Version
配置:Named
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:False

-TypeName

このコマンドレットが書式設定データに対して取得する型名を指定します。 型名を入力します。 ワイルドカードを使用できます。

型:String[]
配置:0
規定値:None
必須:False
パイプライン入力を受け取る:False
ワイルドカード文字を受け取る:True

入力

None

このコマンドレットにオブジェクトをパイプすることはできません。

出力

ExtendedTypeDefinition