トピック
    about_Requires

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


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

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


  構文

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

          #requires -PsSnapIn <PsSnapIn> [-Version <N>[.<n>]]


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

          #requires -Version <N>[.<n>]


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

          #requires –ShellId <ShellId>


  使用規則

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

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

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


  例

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

          #requires –PsSnapIn Microsoft.PowerShell.Security


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

          "スクリプト '<script-name>' を実行できません。このスクリプトの ""#requires"" 
          ステートメントで指定された次の 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



目次