win32_get_last_control_message
(PECL win32service >=0.1.0)
win32_get_last_control_message — サービスに送信された直近の制御メッセージを返す
説明
サービスプロセスに送信された、直近の制御コードを返します。 サービスの実行中は、サービスを停止させる必要がないかを調べるために 定期的にこれをチェックすべきです。
0.2.0 以降では、この関数は "cli" SAPI でのみ動作します。 他の SAPI では、この関数は無効になっています。
パラメータ
この関数にはパラメータはありません。
戻り値
制御コード定数を返します。以下の
Win32Service サービス制御メッセージ定数
のひとつです。
WIN32_SERVICE_CONTROL_CONTINUE,
WIN32_SERVICE_CONTROL_DEVICEEVENT,
WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE,
WIN32_SERVICE_CONTROL_INTERROGATE,
WIN32_SERVICE_CONTROL_NETBINDADD,
WIN32_SERVICE_CONTROL_NETBINDDISABLE,
WIN32_SERVICE_CONTROL_NETBINDENABLE,
WIN32_SERVICE_CONTROL_NETBINDREMOVE,
WIN32_SERVICE_CONTROL_PARAMCHANGE,
WIN32_SERVICE_CONTROL_PAUSE,
WIN32_SERVICE_CONTROL_POWEREVENT,
WIN32_SERVICE_CONTROL_PRESHUTDOWN,
WIN32_SERVICE_CONTROL_SESSIONCHANGE,
WIN32_SERVICE_CONTROL_SHUTDOWN,
WIN32_SERVICE_CONTROL_STOP。
値が 128 から 255 の場合、制御コードはカスタムの値です。
エラー / 例外
バージョン 1.0.0 より前のバージョンでは、SAPI が "cli" でない場合、
この関数は E_ERROR レベルのエラーを発生させていました。
バージョン 1.0.0 移行は、
SAPI が "cli" でない場合、
Win32ServiceException がスローされます。
変更履歴
| バージョン | 説明 |
|---|---|
| PECL win32service 1.0.0 |
引数に不正な値があった場合、
ValueError をスローするようになりました。
これより前のバージョンでは、false を返していました。
|
| PECL win32service 1.0.0 | エラー時に Win32ServiceException をスローするようになりました。 これより前のバージョンでは、 Win32 エラーコード を返していました。 |
| PECL win32service 0.2.0 |
この関数は "cli" SAPI でのみ動作するようになりました。
|
参考
- win32_start_service_ctrl_dispatcher() - スクリプトを SCM に登録し、指定した名前でサービスとして稼動させる ようにする
- win32_set_service_status() - サービスの状態を更新する
- win32_set_service_exit_mode() - Define or return the exit mode for the current running service
- win32_set_service_exit_code() - Define or return the exit code for the current running service
- Win32Service サービス制御メッセージ定数
User Contributed Notes
