ServiceBase.OnStop メソッド

定義

派生クラスで実装されている場合は、サービス コントロール マネージャー (SCM) によって Stop コマンドがサービスに送信されたときに実行されます。 サービスの実行が停止したときに実行するアクションを指定します。

protected:
 virtual void OnStop();
protected virtual void OnStop();
abstract member OnStop : unit -> unit
override this.OnStop : unit -> unit
Protected Overridable Sub OnStop ()

注釈

OnStopを使用して、サービスが Stop コマンドを受け取ったときに発生する処理を指定します。

SCM は Stop コマンドを受け取ると、 CanStop の値を使用して、サービスが Stop コマンドを受け入れるかどうかを確認します。 CanStoptrue場合は、Stop コマンドがサービスに渡され、OnStop メソッドが定義されている場合は呼び出されます。 OnStopがサービスに実装されていない場合、SCM は Stop コマンドを処理します。

CanStopfalse場合、SCM は Stop コマンドを無視します。 サービスに渡されません。 Stop コマンドは例外を返し、スローします。

OnStop は、派生クラスでオーバーライドされることが想定されています。 サービスを役立てるには、 OnStartOnStop の両方をサービス クラスに実装する必要があります。

適用対象

こちらもご覧ください