win32_set_service_pause_resume_state

現在実行中のサービスに対する pause/resume ケイパビリティを定義するか返す

説明

bool win32_set_service_pause_resume_state(bool $state = true)

state パラメータを指定すると、 pause/resume ケイパビリティの値が変更されます。

警告

この関数は Windowsサービスが実行されているコンテクスト中で、 "cli" SAPI でのみ動作します。 他の SAPI では、この関数は無効になっています。

パラメータ

state

サービスの pause/resume ケイパビリティを有効にする場合、 true を指定します。 無効にする場合は false を指定します。

戻り値

現在、または以前の pause/resume ケイパビリティの状態を返します。

エラー / 例外

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 Error Code を返していました。

参考

  • win32_start_service_ctrl_dispatcher
  • win32_set_service_status
  • win32_set_service_exit_code