Get-FormatData
現在のセッションの書式設定データを取得します。
構文
Get-FormatData [[-TypeName] <string[]>] [<CommonParameters>]
説明
Get-FormatData コマンドレットは、現在のセッションの書式設定データを取得します。
セッションの書式設定データには、$pshome ディレクトリなどに格納されている Format.ps1xml 書式設定ファイル内の書式設定データ、セッションにインポートしたモジュールの書式設定データ、Import-PSSession コマンドレットを使用してセッションにインポートしたコマンドの書式設定データなどがあります。
このコマンドレットを使用して、書式設定データを調べることができます。さらに、Export-FormatData コマンドレットを使用することで、オブジェクトをシリアル化 (XML に変換) し、Format.ps1xml ファイルに保存することができます。
Windows PowerShell の書式設定ファイルの詳細については、「about_Format.ps1xml」を参照してください。
パラメーター
-TypeName <string[]>
指定された型名の書式設定データのみを取得します。型の名前を入力します。ワイルドカードを使用できます。
必須 |
false |
位置 |
1 |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
true |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
入力 |
なし パイプを使用してこのコマンドレットに入力を渡すことはできません。 |
出力 |
System.Management.Automation.ExtendedTypeDefinition |
例 1
C:\PS>get-formatdata
説明
-----------
このコマンドは、セッションの書式設定データをすべて取得します。
例 2
C:\PS>get-formatdata -typename Microsoft.Wsman*
説明
-----------
このコマンドは、名前が "Microsoft.Wsman" で始まる書式設定データ項目を取得します。
例 3
C:\PS>$f = get-formatdata -typename helpinfoshort
C:\PS> $f
TypeName FormatViewDefinition
-------- --------------------
HelpInfoShort {help , TableControl}
C:\PS> $f.FormatViewDefinition[0].control
Headers Rows
------- ----
{System.Management.Automation.TableControlColumnHeader, System.Manageme... {System.Management.Automation.TableControlRow}
C:\PS> $f.FormatViewDefinition[0].control.headers
Label Alignment Width
----- --------- -----
Name Left 33
Category Left 9
Undefined 0
説明
-----------
この例は、書式設定データ オブジェクトを取得し、そのプロパティを調べる方法を示しています。
例 4
C:\PS>$a = get-formatdata
C:\PS> import-module bitstransfer
C:\PS> $b = get-formatdata
C:\PS> compare-object $a $b
InputObject SideIndicator
----------- -------------
Microsoft.BackgroundIntelligentTransfer.Management.BitsJob =>
C:\PS> get-formatdata *bits* | export-formatdata -filepath c:\test\bits.format.ps1xml
C:\PS> get-content c:\test\bits.format.ps1xml
<?xml version="1.0" encoding="utf-8"?><Configuration><ViewDefinitions>
<View><Name>Microsoft.BackgroundIntelligentTransfer.Management.BitsJob</Name>
...
説明
-----------
この例は、Get-FormatData および Export-FormatData を使用して、モジュールによって追加された書式設定データをエクスポートする方法を示しています。
最初の 4 つのコマンドは、BitsTransfer モジュールによってセッションに追加された書式型を、Get-FormatData、Import-Module、および Compare-Object の各コマンドレットを使用して識別します。
5 番目のコマンドは Get-FormatData コマンドレットを使用して、BitsTransfer モジュールによって追加された書式型を取得します。書式型のオブジェクトは、パイプライン演算子 (|) を介して Export-FormatData コマンドレットに送られ、再び XML に変換されて、指定された format.ps1xml ファイルに保存されます。
最後のコマンドは、format.ps1xml ファイルの内容 (抜粋) を表示します。