@Return (JavaScript)

呼び出し元の関数またはユーザーインターフェースに制御権を戻します。

定義場所

@Functions (JavaScript)

構文

@Return(value:any) : void
パラメータ 説明
value 戻り値。パラメータが指定されなかった場合または null 値が指定された場合は、戻り値に空ストリングが設定されます。

使用法

@Return 関数を呼び出し先の関数内に記述すると、制御権が呼び出し元の関数に戻されます。

@Return 関数を最上位階層の関数内に記述すると、制御権がユーザーインターフェースに戻されます。

通常は、@Return 関数を記述する必要はありません。関数の最終ステートメントが実行されると、制御権が自動的に呼び出し元に戻されます。 関数の最終ステートメントに値が記述されている場合は、その値が戻されます。 ただし、@Return 関数や return ステートメントを記述して明示的に制御権を戻しても問題はありません。

(1) 以下の例は、計算結果フィールドの式を示したものです。条件に従って値を返します。
var n = @GetNumberField("//field3");
@If(
	n > 0, @Return("Positive number"),
	// else if
	n < 0, @Return("Negative number"),
	// else
	@Return("Zero")
);

(2) 以下の例のように @Return 関数を記述しなくても、結果は (1) と同じになります。ほとんどの場合、この関数を記述する必要はありません。

var n = @GetNumberField("//field3");
@If(
	n > 0, "Positive number",
	// else if
	n < 0, "Negative number",
	// else
	"Zero"
);

(3) 以下の例では、最後の条件式で空ストリングを返しています。

var n = @GetNumberField("//field3");
@If(
	n > 0, @Return("Positive number"),
	// else if
	n < 0, @Return("Negative number"),
	// else
	@Return()
);

(4) 以下の例では、関数から制御権を呼び出し元に戻す場合を示しています。

function testNumber() {
var n = @GetNumberField("//field3");
@If(
	n > 0, @Return("Positive number"),
	// else if
	n < 0, @Return("Negative number"),
	// else
	@Return("Zero")
);
}

@Return("testNumber = " + testNumber());