about_Language_Keywords
簡単な説明
PowerShell スクリプト言語のキーワード (keyword)について説明します。
詳細な説明
PowerShell には、次の言語キーワード (keyword)があります。 詳細については、キーワード (keyword)に関するトピックと、表に続く情報を参照してください。
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> ...]
}
clean
キーワード (keyword)は clean
PowerShell 7.3 で追加されました。 キーワード (keyword)は、関数の 、process
およびend
ブロックの後begin
で実行することが保証されるコード ブロックを定義します。 end
ブロックとは異なり、他のいずれかのclean
ブロックで終了エラーが発生した場合でも、ブロックは常に実行されます。
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 を追加することで自動的に正の数に変換されます。 たとえば、次 -2
に 254
変換されます。
PowerShell では、ステートメントによって exit
変数の値が $LASTEXITCODE
設定されます。 Windows コマンド シェル (cmd.exe
) では、exit ステートメントによって環境変数の値が %ERRORLEVEL%
設定されます。
数値以外の引数またはプラットフォーム固有の範囲外の引数は、次の 0
値に変換されます。
次の例では、ユーザーはスクリプト ファイルtest.ps1
に4
追加exit 4
してエラー レベル変数の値を設定します。
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
定義します catch
。 finally
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
指定することもできます。 関数ステートメントの一覧には、ステートメント リストをbegin
process
end
含dynamicparam
めることができます。
構文:
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>)
関連項目
PowerShell