PowerShell HelpFile - about_Command_Syntax
 記事記号:[me1519] 初版:2011/May/10

この文書は、Windows PowerShellのヘルプ機能で表示される内容を再構成したものです。

トピック
    about_Command_Syntax

簡易説明
    ヘルプの Windows PowerShell の構文で使用される表記法について説明します。

詳細説明
    Get-Help コマンドレットを実行すると、コマンドレットのパラメーターの使用方法
    が表示されます。Get-Help コマンドレットでは、次の特殊な記号が使用されます。

        山かっこ (<>) はプレースホルダー テキストを示します。
        角かっこ ([]) はオプションの項目を示します。
        波かっこ ({}) は値の選択肢を示します。

    コマンドレットには、複数のパラメーター セットが指定される場合があります。異
    なるパラメーター セットでも、一部のパラメーターは同じものであることがありま
    す。Get-Help コマンドレットを実行すると、コマンドレットのすべてのパラメータ
    ー セットが表示されます。

    パラメーターに関する追加情報は、パラメーターの説明およびパラメーター属性テー
    ブルにあります。パラメーターの詳細な情報を表示するには、Get-Help の Full パ
    ラメーターまたは Parameter 
    パラメーターを使用します。

  構文
      Windows PowerShell のコマンドレット ヘルプ、ヘルプ トピック、およびその他
      のドキュメントでは、構文の説明において、コマンドレットで次の表記法が使用さ
      れます。

           - 
                       [- ] 
                       [-] 
                       [-]  

      New-Alias コマンドレットの構文を次に示します。

          New-Alias [-Force] [-PassThru] [-Scope ]
              [-Option {None | ReadOnly | Constant | Private | AllScope}]
              [-Description ] [-Name]  [-Value] 
              [-confirm] [-whatif] []

      この構文では、読みやすさのために大文字が使用されていますが、Windows Powers
      hell では大文字と小文字は区別されません。

      パラメーターは順に表示されます。パラメーターの順序は、そのパラメーター名が
      オプションである場合にのみ重要となります。コマンドレットの使用時にパラメー
      ター名を指定しない場合、Windows PowerShell では位置および型に基づいてパラ
      メーターに値が割り当てられます。

      パラメーター名の前にはハイフン (-) が付きます。スイッチ パラメーターは、値
      の型を伴わずに表示されます。その他のパラメーターは、必須引数の Microsoft 
      .NET Framework 型または使用可能な値の列挙と共に表示されます。.NET Framewor
      k 型の詳細については、http://msdn.microsoft.com/ja-jp/library/ms229335(VS.
      80).aspx を参照してください。

      山かっこ (<>) はプレースホルダー テキストを示します。このテキストでは、項
      目の種類 (文字列やプロセス オブジェクトなど) を記述することができます。
      このテキストは 1 つまたは複数の共通パラメーターのプレースホルダーである場
      合もあります。

      角かっこ ([]) はオプションの項目を示します。パラメーターが省略可能であるか、
      必須パラメーターの名前が省略可能であることを示します。スイッチ パラメータ
      ーは、常に省略可能です。

      波かっこ ({}) は、列挙型の値の前後に表示されます。New-Alias コマンドレット
      の例では、Option パラメーターには一覧表示されているいずれの値を指定するこ
      ともできます。

  オプションの項目
      オプションの項目は、角かっこ ([]) で囲まれています。たとえば、New-Alias コ
      マンドレットの構文の説明では、Scope パラメーターはオプションです。これはパ
      ラメーター名と型を角かっこが囲む構文で示されます。

          [-Scope ]

      次の例は共に、New-Alias コマンドレットの正しい使用方法を示しています。

          New-Alias -Name utd -Value Update-TypeData New-Alias -Name 
          utd -Value Update-TypeData -Scope global

      パラメーターの値が必須であっても、パラメーター名は省略可能の場合があります。
      これは、New-Alias コマンドレットの次の例のように、パラメーター名を角かっこ
      で囲み、パラメーターの型は角かっこで囲まない構文で示します。

          [-Name]  [-Value] 

      次のコマンドでは、New-Alias コマンドレットが正しく使用されています。コマン
      ドの結果は同じになります。

          New-Alias -Name utd -Value Update-TypeData 
          New-Alias -Name utd Update-TypeData
          New-Alias utd -ValueUpdate-TypeData
          New-Alias utdUpdate-TypeData

      入力時にパラメーター名がステートメントに含まれていない場合、Windows PowerS
      hell は、その引数の位置を使用して値をパラメーターに割り当てようとします。

      次の例は不完全です。

          New-Alias utd

      このコマンドレットでは、Name および Value パラメーターの両方に値を指定する
      必要があります。

      構文の例では、角かっこは .NET Framework 型に対する名前付けおよびキャストに
      も使用されています。このような場合、角かっこは要素が省略可能であることを示
      すわけではありません。

  配列引数
      構文の説明では、角かっこは配列を表すためにも使用されています。次の例は、Re
      start-Service コマンドレットの構文を示しています。

        Restart-Service [-Name]  [-Include ] 
              [-Exclude ] [-Force] [-PassThru] [-Confirm] [-WhatIf] 
              []

      Name パラメーターには、引数が必要です。具体的には、再起動するサービスの名前
      が必要です。次の例のように、サービスのコンマ区切り一覧を指定することができ
      ます。

          Restart-Service RasAuto, RasMan, RemoteAccess

関連項目
    Get-Help
	
記事で解説しているパソコンの環境
 基本ソフト: Windows 7
 キーワード: Windows PowerShell、ヘルプ、HelpFile、about_Command_Syntax
ご利用数: 1919670
感想・要望・問い合わせは こちら