PowerShell HelpFile - about_requires
 記事記号:[me1574] 初版:2011/May/10

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

トピック
    about_Requires

簡易説明
    指定したスナップインおよびバージョンを要求することで、スクリプトの実行を禁止
    します。


詳細説明
    #Requires ステートメントは、Windows PowerShell バージョン、スナップイン、お
    よびスナップイン バージョンの前提条件が満たされない場合にスクリプトの実行を
    禁止します。前提条件が満たされない場合、Windows PowerShell は、スクリプトを
    実行しません。

    #Requires ステートメントは、任意のスクリプトで使用できます。関数、コマンドレ
    ット、およびスナップイン内では使用できません。


  構文

      前提条件とするスナップインおよびスナップインのバージョンを指定するには、次
      の構文を使用します。

          #requires -PsSnapIn  [-Version [.]]


      前提条件とする Windows PowerShell の最小バージョンを指定するには、次の構文
      を使用します。

          #requires -Version [.]


      前提条件とするシェルを指定するには、次の構文を使用します。

          #requires ?ShellId 


  使用規則

      - #Requires ステートメントは、スクリプト内の行の最初のアイテムである必要が
        あります。

      - 1 つのスクリプトに複数の #Requires ステートメントを記述できます。

      - #Requires ステートメントは、スクリプト内の任意の行に記述できます。


  例

      次のステートメントは、Microsoft.PowerShell.Security スナップインを前提条件
      として指定します。

          #requires ?PsSnapIn Microsoft.PowerShell.Security


      Microsoft.PowerShell.Security スナップインが読み込まれない場合、スクリプト
      は実行されず、Windows PowerShell によって次のエラー メッセージが表示されま
      す。

          "スクリプト '' を実行できません。このスクリプトの ""#req
          uires"" ステートメントで指定された次の Windows PowerShell スナップイン
          がありません: Microsoft.PowerShell.Security。"


      次のステートメントは、Windows PowerShell 2.0 以降のバージョンの Microsoft.
      PowerShell.Security スナップインを前提条件として指定します。

          #requires ?PsSnapIn Microsoft.PowerShell.Security ?Version 2


      次のステートメントは、Windows PowerShell 2.0 以降のバージョンを前提条件と
      して指定します。

          #requires ?Version 2.0


      次のスクリプトには、2 つの #Requires ステートメントが定義されています。両
      方のステートメントに指定された要件が満たされる必要があります。それ以外の場
      合、スクリプトは実行されません。それぞれの #Requires ステートメントは、行
      の最初のアイテムである必要があります。

          #requires ?PsSnapIn Microsoft.PowerShell.Security ?Version 2
          Get-WMIObject WIN32_LogicalDisk | out-file K:\status\DiskStatus.txt
          #requires ?Version 2


      次の #Requires ステートメントは、指定されたシェル ID と現在のシェル ID が
      一致しない場合、スクリプトを実行しません。現在のシェル ID は、$ShellId 変
      数に格納されます。

          #requires ?ShellId MyLocalShell


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