about_Language_Keywords

簡単な説明

PowerShell スクリプト言語のキーワード (keyword)について説明します。

長い説明

PowerShell には、次の言語キーワード (keyword)があります。 詳細については、キーワード (keyword)に関するトピックと、表に続く情報を参照してください。

キーワード リファレンス
begin about_Functions、about_Functions_Advanced
break about_Break、about_Trap
catch about_Try_Catch_Finally
class about_Classes
continue about_Continue、about_Trap
data about_Data_Sections
define 今後使用するために予約されます
do about_Do、about_While
dynamicparam about_Functions_Advanced_Parameters
else about_If
elseif about_If
end about_Functions、about_Functions_Advanced_Methods
enum about_Enum
exit このトピックで説明する
filter about_Functions
finally about_Try_Catch_Finally
for about_For
foreach about_ForEach
from 今後使用するために予約されます
function about_Functions、about_Functions_Advanced
hidden about_Hidden
if about_If
in about_ForEach
param about_Functions
process about_Functions、about_Functions_Advanced
return about_Return
static about_Classes
switch about_Switch
throw about_Throw、about_Functions_Advanced_Methods
trap about_Trap、about_Breakabout_Try_Catch_Finally
try about_Try_Catch_Finally
until about_Do
using about_Using、about_Classes
var 今後使用するために予約されます
while about_While、about_Do

PowerShell ワークフローでは、次のキーワード (keyword)が使用されます。

  • inlinescript
  • parallel
  • sequence
  • workflow

PowerShell ワークフローは、PowerShell 5.1 でのみサポートされています。 ワークフローの詳細については、「ワークフローでの PowerShell コマンドの実行」を参照してください

begin

関数の本体の 1 つの部分を、,process、およびendキーワード (keyword)と共dynamicparamに指定します。 ステートメント リストは begin 、パイプラインからオブジェクトを受信する前に 1 回実行されます。

構文:

function <name> {
    dynamicparam {<statement list>}
    begin {<statement list>}
    process {<statement list>}
    end {<statement list>}
}

break

スクリプトがループを終了します。

構文:

while (<condition>) {
   <statements>
   ...

   break
   ...

   <statements>
}

catch

付随するステートメント・リストでエラーが発生した場合に実行するステートメント・リストを try 指定します。 エラーの種類には角かっこが必要です。 角かっこの 2 番目のペアは、エラーの種類が省略可能であることを示します。

構文:

try {<statement list>}
catch [[<error type>]] {<statement list>}

class

PowerShell で新しいクラスを指定します。

構文:

class <class-name> {
    [[hidden] [static] <property-definition> ...]
    [<class-name>([argument-list>]) {<constructor-statement-list>} ...]
    [[hidden] [static] <method-definition> ...]
}

continue

スクリプトがループの実行を停止し、条件に戻ります。 条件が満たされた場合、スクリプトはループを再度開始します。

構文:

while (<condition>) {
   <statements>
   ...

   continue
   ...

   <statements>
}

data

スクリプトで、スクリプト ロジックからデータを分離するセクションを定義します。 ステートメントや一部の制限付きコマンドを含 if めることもできます。

構文:

data <variable> [-supportedCommand <cmdlet-name>] {<permitted content>}

do

ループコンストラクトとして、whileまたはuntilキーワード (keyword)と共に使用されます。 PowerShell は、ステートメント リストを少なくとも 1 回実行します。使用する whileループとは異なります。

while の構文:

do {<statement list>} while (<condition>)

until の構文:

do {<statement list>} until (<condition>)

dynamicparam

関数の本体の 1 つの部分を、,process、およびendキーワード (keyword)と共beginに指定します。 動的パラメーターは実行時に追加されます。

構文:

function <name> {
   dynamicparam {<statement list>}
   begin {<statement list>}
   process {<statement list>}
   end {<statement list>}
}

else

キーワード (keyword)と共にif使用して、既定のステートメント リストを指定します。

構文:

if (<condition>) {<statement list>}
else {<statement list>}

elseif

追加の条件をif指定するために、キーワード (keyword)とelse共に使用されます。 else キーワード (keyword)は省略可能です。

構文:

if (<condition>) {<statement list>}
elseif (<condition>) {<statement list>}
else {<statement list>}

end

関数の本体の 1 つの部分を、,begin、およびendキーワード (keyword)と共dynamicparamに指定します。 ステートメント リストは end 、すべてのオブジェクトがパイプラインから受信された後に 1 回実行されます。

構文:

function <name> {
   dynamicparam {<statement list>}
   begin {<statement list>}
   process {<statement list>}
   end {<statement list>}
}

enum

enum は列挙型を宣言するために使用されます。列挙子リストと呼ばれる名前付きラベルのセットで構成される個別の型。

構文:

enum <enum-name> {
    <label> [= <int-value>]
    ...
}

exit

PowerShell がスクリプトまたは PowerShell インスタンスを終了します。

構文:

exit
exit <exitcode>

File パラメーターと共に使用pwshする場合、(スクリプト) ファイル自体に、.ps1スクリプトの実行中に発生するエラーまたは例外を処理するための手順が含まれている必要があります。 ステートメントは、スクリプトの exit 実行後の状態を示すためにのみ使用してください。

Windows では、次の間 [int]::MinValue の任意の数が [int]::MaxValue 許可されます。

Unix では、正の数値の間[byte]::MinValue[byte]::MaxValueでのみ許可されます。 スルー-255の範囲内の負の-1数は、256 を追加することで自動的に正の数に変換されます。 たとえば、次 -2254変換されます。

PowerShell では、ステートメントによって exit 変数の値が $LASTEXITCODE 設定されます。 Windows コマンド シェル (cmd.exe) では、exit ステートメントによって環境変数の値が %ERRORLEVEL% 設定されます。

数値以外の引数またはプラットフォーム固有の範囲外の引数は、次の 0値に変換されます。

次の例では、ユーザーはスクリプト ファイルに追加exit 4することで、エラー レベル変数の値を 4 に設定します。test.ps1

C:\scripts\test>type test.ps1
1
2
3
exit 4

C:\scripts\test>pwsh -file ./test.ps1
1
2
3

C:\scripts\test>echo %ERRORLEVEL%
4

実行 pwsh.exe -File <path to a script> し、スクリプト ファイルがコマンドで exit 終了すると、終了コードはコマンドで使用される数値引数に exit 設定されます。 スクリプトにステートメントがないexit場合、終了コードは、スクリプトがエラーなしで完了したとき、または1スクリプトが未処理の例外から終了したときに常0に行われます。

filter

ステートメント リストが入力オブジェクトごとに 1 回実行される関数を指定します。 ブロックのみを含む関数と同じ効果があります process

構文:

filter <name> {<statement list>}

finally

に関連付けられたステートメントの後に実行されるステートメント リストを try 定義します catchfinally Ctrl C キー+を押してスクリプトを終了した場合や、スクリプトでキーワード (keyword)をexit使用した場合でも、ステートメント リストが実行されます。

構文:

try {<statement list>}
catch [<error type>] {<statement list>}
finally {<statement list>}

for

条件を持つループを定義します。

構文:

for (<initialize>; <condition>; <iterate>) { <statement list> }

foreach

コレクションの各メンバーを使用してループを定義します。

構文:

foreach (<item> in <collection>) { <statement list> }

from

将来利用するために予約されています。

function

再利用可能なコードの名前付きステートメント リストを作成します。 関数が属するスコープに名前を付けることができます。 キーワード (keyword)を使用して、1 つ以上の名前付きパラメーターをparam指定することもできます。 関数ステートメントの一覧には、ステートメント リストをbeginprocessenddynamicparamめることができます。

構文:

function [<scope:>]<name> {
   param ([type]<$pname1> [, [type]<$pname2>])
   dynamicparam {<statement list>}
   begin {<statement list>}
   process {<statement list>}
   end {<statement list>}
}

また、関数名の後にステートメント リストの外部で 1 つ以上のパラメーターを定義することもできます。

構文:

function [<scope:>]<name> [([type]<$pname1>, [[type]<$pname2>])] {
   dynamicparam {<statement list>}
   begin {<statement list>}
   process {<statement list>}
   end {<statement list>}
}

if

条件を定義します。

構文:

if (<condition>) {<statement list>}

hidden

コマンドレット、IntelliSense、タブ補完結果の既定の Get-Member 結果からクラス メンバーを非表示にします。

構文:

hidden [data type] $member_name

in

コレクションの各メンバーを foreach 使用するループを作成するためにステートメントで使用されます。

構文:

foreach (<item> in <collection>){<statement list>}

param

関数内のパラメーターを定義します。

構文:

function [<scope:>]<name> {
   param ([type]<$pname1>[, [[type]<$pname2>]])
   <statement list>
}

process

関数の本体の一部を、,begin、およびendキーワード (keyword)と共dynamicparamに指定します。 ステートメント リストが process パイプラインから入力を受け取ると、ステートメント リストは process パイプラインの要素ごとに 1 回実行されます。 パイプラインがオブジェクトを提供しない場合、 process ステートメント リストは実行されません。 コマンドがパイプラインの最初のコマンドである場合、ステートメント リストは process 1 回実行されます。

構文:

function <name> {
   dynamicparam {<statement list>}
   begin {<statement list>}
   process {<statement list>}
   end {<statement list>}
}

return

PowerShell がスクリプトや関数などの現在のスコープから離れ、省略可能な式を出力に書き込みます。

構文:

return [<expression>]

static

定義されているプロパティまたはメソッドが、定義されているクラスのすべてのインスタンスに共通であることを指定します。

使用例を参照してください class

switch

複数の条件をチェックするには、ステートメントをswitch使用します。 ステートメントは switch 一連の if ステートメントに相当しますが、より簡単です。

ステートメントには switch 、各条件とオプションのアクションが一覧表示されます。 条件が取得されると、アクションが実行されます。

構文 1:

switch [-regex|-wildcard|-exact][-casesensitive] ( <value> )
{
   <string>|<number>|<variable>|{ <expression> } {<statement list>}
   <string>|<number>|<variable>|{ <expression> } {<statement list>}
   ...

   default {<statement list>}
}

構文 2:

switch [-regex|-wildcard|-exact][-casesensitive] -file <filename>
{
   <string>|<number>|<variable>|{ <expression> } {<statement list>}
   <string>|<number>|<variable>|{ <expression> } {<statement list>}
   ...

   default {<statement list>}
}

throw

オブジェクトをエラーとしてスローします。

構文:

throw [<object>]

trap

エラーが発生した場合に実行するステートメント リストを定義します。 エラーの種類には角かっこが必要です。 角かっこの 2 番目のペアは、エラーの種類が省略可能であることを示します。

構文:

trap [[<error type>]] {<statement list>}

try

ステートメントの実行中にエラーに対してチェックするステートメント リストを定義します。 エラーが発生した場合、PowerShell は 1 つまたは 1 つのfinallyステートメントでcatch引き続き実行されます。 エラーの種類には角かっこが必要です。 角かっこの 2 番目のペアは、エラーの種類が省略可能であることを示します。

構文:

try {<statement list>}
catch [[<error type>]] {<statement list>}
finally {<statement list>}

until

ステートメント リストが do 少なくとも 1 回実行されるループコンストラクトとしてステートメントで使用されます。

構文:

do {<statement list>} until (<condition>)

using

セッションで使用される名前空間を指定できます。 型名、クラス、およびメンバーを参照するために必要な型指定が少なくなります。 モジュールのクラスを含めることもできます。

名前空間の構文:

using namespace <.Net-namespace>

モジュールの構文:

using module <module-name>

アセンブリ構文:

using assembly <.NET-assembly-path>

詳細については、「about_Using」を参照してください

while

ステートメントは while ループ構造であり、ステートメントが実行される前に条件がテストされます。 条件が false の場合、ステートメントは実行されません。

ステートメントの構文:

while (<condition>) {
   <statements>
 }

ステートメントで do 使用する場合は、 while ステートメント リストが少なくとも 1 回実行されるループコンストラクトの一部です。

do ループ構文:

do {<statement list>} while (<condition>)

関連項目