ServiceBase.OnStop メソッド

  • リファレンス

定義

名前空間:
System.ServiceProcess
アセンブリ:
System.ServiceProcess.ServiceController.dll
アセンブリ:
System.ServiceProcess.dll
パッケージ:
System.ServiceProcess.ServiceController v8.0.0
パッケージ:
System.ServiceProcess.ServiceController v9.0.0-preview.3.24172.9
ソース:
ServiceBase.cs
ソース:
ServiceBase.cs
ソース:
ServiceBase.cs
ソース:
ServiceBase.cs

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

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

注釈

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

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

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

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

適用対象

こちらもご覧ください