ja-JP/about_Parameters.help.txt
|
TOPIC about_Parameters 簡単な説明 コマンド(コマンドレット・関数・スクリプト)で使うパラメーターの 指定方法と、その特性(必須・位置・型など)を説明します。 詳細な説明 多くのコマンドレットや関数は、動作を制御するためのパラメーターを 持ちます。パラメーターはコマンド名の後ろに指定します。 パラメーターの基本的な書式は次のとおりです。 -<パラメーター名> <パラメーター値> -<パラメーター名>:<パラメーター値> 先頭のハイフン (-) は、その語がパラメーター名であることを PowerShell に 伝えます。値はパラメーター名の後ろに、スペースまたはコロンで区切って 指定します。 例: Get-ChildItem -Path C:\Windows Get-ChildItem -Path:C:\Windows パラメーターのヘルプを調べる あるコマンドのパラメーターを調べるには Get-Help を使います。 Get-Help <コマンド名> -Parameter * Get-Help Get-ChildItem -Parameter Path -Parameter ではワイルドカードも使えます。 パラメーターの特性 Get-Help の表示には、各パラメーターについて次のような情報が含まれます。 必須 (Required?) true の場合、そのパラメーターは必須です。指定しないでコマンドを 実行すると、PowerShell は値の入力を求めるプロンプトを表示します。 false の場合は省略できます。 位置 (Position?) named の場合は名前付きパラメーターで、コマンド行のどこに書いても かまいません(パラメーター名が必須)。0 以上の整数の場合は位置 パラメーターで、その順序どおりに値を並べればパラメーター名を省略 できます。 型 (Type) パラメーターが受け取る .NET の型を示します(Int32, String など)。 スペースを含む文字列値は、引用符で囲むかエスケープが必要です。 既定値 (Default value) パラメーターを指定しなかったときに使われる値です。必須パラメーター には既定値はありません。 複数の値を受け付けるか (Accept multiple values?) true の場合、カンマ区切りのリストや配列を渡せます。 Get-ChildItem -Path C:\, D:\ パイプライン入力を受け付けるか (Accept pipeline input?) パイプ (|) で値を渡せるかどうかを示します。次の種類があります。 - by Value(値による): 入力オブジェクトの型が一致すれば結び付く - by Property Name(プロパティ名による): 入力オブジェクトの プロパティ名がパラメーター名と一致すれば結び付く ワイルドカードを受け付けるか (Accept wildcard characters?) true の場合、値に * や ? などのワイルドカードを使えます。 位置パラメーターと名前付きパラメーターの例 位置パラメーターは、正しい順序で書けば名前を省略できます。 Move-Item C:\test.txt D:\test.txt 名前付きで書くと、順序を入れ替えても同じ意味になります。 Move-Item -Destination D:\test.txt -Path C:\test.txt 名前付き指定は順序に依存せず、コマンドの意図が読み取りやすくなります。 関連項目 about_Functions about_Functions_Advanced_Parameters about_Command_Syntax about_Pipelines Get-Help ---- 原文: PowerShell-Docs (CC BY 4.0) の翻訳 / PSHelpJaJP |