ServiceBase.OnCustomCommand(Int32) メソッド

定義

派生クラスに実装されると、OnCustomCommand(Int32) は、サービス コントロール マネージャー (SCM) でカスタム コマンドがサービスに渡されるときに、実行されます。When implemented in a derived class, OnCustomCommand(Int32) executes when the Service Control Manager (SCM) passes a custom command to the service. パラメーター値が設定されているコマンドの発生時に実行されるアクションを指定します。Specifies actions to take when a command with the specified parameter value occurs.

protected:
 virtual void OnCustomCommand(int command);
protected virtual void OnCustomCommand (int command);
abstract member OnCustomCommand : int -> unit
override this.OnCustomCommand : int -> unit
Protected Overridable Sub OnCustomCommand (command As Integer)

パラメーター

command
Int32

サービスに送信されたコマンド メッセージ。The command message sent to the service.

注釈

OnCustomCommandでは、サービスを開始、停止、一時停止、および続行する以外に、追加の機能を指定できます。OnCustomCommand lets you specify additional functionality beyond starting, stopping, pausing and continuing services.

SCM はカスタムコマンドを調べて、渡されたパラメーターがcommandサービスでサポートされているかどうかを確認しません。The SCM does not examine the custom command to verify whether the service supports the command parameter passed in. カスタムコマンドがサービスに直接渡されます。It passes the custom command directly to the service. サービスがcommandパラメーターを認識しない場合は、何も実行されません。If the service does not recognize the command parameter, it does nothing.

カスタムコマンドは、 ExecuteCommand ServiceControllerコンポーネント内のステートメントによって発生します。Custom commands are raised by an ExecuteCommand statement in a ServiceController component. Switch ステートメントを使用するか、..次に、サービスで定義するカスタムコマンドを処理する条件を指定します。Use a switch statement or if..then condition to handle the custom commands you define on your service.

アプリケーションで定義したりでOnCustomCommand使用したりできるカスタムコマンドの値は、128と255の間の値のみです。The only values for a custom command that you can define in your application or use in OnCustomCommand are those between 128 and 255. 128未満の整数は、システム予約値に対応します。Integers below 128 correspond to system-reserved values.

AutoLogプロパティがtrueの場合、他のすべてのコマンドと同様に、イベントログにエントリを書き込み、メソッドの実行が成功したか失敗したかを報告します。If the AutoLog property is true, custom commands, like all other commands, write entries to the event log to report whether the method execution succeeded or failed.

適用対象

こちらもご覧ください