JScript および VBScript カスタム アクションの戻り値

JScript または Visual Basic、Scripting Edition (VBScript) で記述されたカスタム アクションでは、オプションの関数を呼び出すことができます。 これらの関数は、次の表に示す値のいずれかを返す必要があります。

戻り値	値	説明
msiDoActionStatusNoAction	0	アクションが実行されていません。
msiDoActionStatusSuccess	IDOK = 1	アクションが正常に完了しました。
msiDoActionStatusUserExit	IDCANCEL = 2	ユーザーによる途中終了。
msiDoActionStatusFailure	IDABORT = 3	致命的なエラー JScript または VBScript の解析中または実行中にエラーが発生した場合に返されます。
msiDoActionStatusSuspend	IDRETRY = 4	シーケンスが中断されました。後で再開されます。
msiDoActionStatusFinished	IDIGNORE = 5	残りのアクションをスキップします。 エラーではありません。

 

Windows インストーラーは、戻り値をログ ファイルに書き込む際に、すべてのアクションからの戻り値を変換することに注意してください。 たとえば、アクションの戻り値がログ ファイルに "1" と表示される場合、アクションは msiDoActionStatusSuccess を返したことを意味します。 この変換の詳細については、「アクションの戻り値のログ記録」を参照してください。

スクリプト カスタム アクションから成功以外の値を返すには、カスタム アクションの関数ターゲットを使用する必要があります。 ターゲット関数は、CustomAction テーブルの Target 列で指定します。

次のスクリプト例は、VBScript カスタム アクションから成功または失敗を返す方法を示しています。

Function MyVBScriptCA()

    If Session.Property("CustomErrorStatus") <> "0" Then
        'return error
        MyVBScriptCA = 3
        Exit Function
    End If

    ' return success
    MyVBScriptCA = 1
    Exit Function

End Function

この VBScript が MyCA.vbs としてインストール パッケージの Binary テーブルに埋め込まれている場合、スクリプトの CustomAction テーブルのエントリは次のようになります。

アクション	Type	source	移行先
MyCustomAction	6	MyCA.vbs	MyVBScriptCA