ControlService 関数 (winsvc.h)
コントロール コードをサービスに送信します。
サービスを停止するときに追加情報を指定するには、 ControlServiceEx 関数を使用します。
構文
BOOL ControlService(
[in] SC_HANDLE hService,
[in] DWORD dwControl,
[out] LPSERVICE_STATUS lpServiceStatus
);
パラメーター
[in] hService
サービスへのハンドル。 このハンドルは、 OpenService または CreateService 関数によって返されます。 このハンドルに必要な アクセス権 は、要求された dwControl コードによって異なります。
[in] dwControl
このパラメーターには、次のいずれかの制御コードを指定できます。
この値は、次の表で説明するように、ユーザー定義のコントロール コードにすることもできます。
| 制御コード | 意味 |
|---|---|
|
サービスは、コントロール コードに関連付けられているアクションを定義します。 hService ハンドルには、SERVICE_USER_DEFINED_CONTROLアクセス権が必要です。 |
[out] lpServiceStatus
最新のサービス状態情報を受信する SERVICE_STATUS 構造体へのポインター。 返される情報には、サービスがサービス 制御マネージャーに報告した最新の状態が反映されます。
サービス コントロール マネージャーは、 GetLastError が 次のいずれかのエラー コードを返す場合にのみ構造体を入力します: NO_ERROR、 ERROR_INVALID_SERVICE_CONTROL、 ERROR_SERVICE_CANNOT_ACCEPT_CTRL、 またはERROR_SERVICE_NOT_ACTIVE。 それ以外の場合、構造体は入力されません。
戻り値
関数が成功すると、戻り値は 0 以外になります。
関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。
サービス コントロール マネージャーでは、次のエラー コードを設定できます。 その他のエラー コードは、サービス コントロール マネージャーによって呼び出されるレジストリ関数によって設定できます。
| リターン コード | 説明 |
|---|---|
|
ハンドルには、必要なアクセス権がありません。 |
|
他の実行中のサービスが依存しているため、サービスを停止できません。 |
|
指定したハンドルが CreateService または OpenService を使用して取得されなかったか、ハンドルが無効になりました。 |
|
要求された制御コードは未定義です。 |
|
要求された制御コードは有効でないか、またはサービスを受け入れ可能ではありません。 |
|
サービスの状態がSERVICE_STOPPED、SERVICE_START_PENDING、またはSERVICE_STOP_PENDINGであるため、要求された制御コードをサービスに送信できません。 |
|
サービスは開始されていません。 |
|
サービスのプロセスは開始されましたが、 StartServiceCtrlDispatcher を呼び出さなかったか、コントロール ハンドラー関数で StartServiceCtrlDispatcher を呼び出したスレッドがブロックされる可能性があります。 |
|
システムがシャットダウンしています。 |
注釈
ControlService 関数は、要求されたコントロール コードをサービスに送信するようにサービス コントロール マネージャー (SCM) に要求します。 SCM は、サービスがコードを受け入れることを指定しており、コントロール コードを送信できる状態である場合にコードを送信します。
SCM は、サービス制御通知をシリアル形式で処理します。1 つのサービスがサービス制御通知の処理を完了してから次のサービス制御通知を送信するまで待機します。 このため、コントロール コードの処理がビジー状態のサービスがある場合、 ControlService の呼び出しは 30 秒間ブロックされます。 タイムアウトの期限が切れたときにビジー 状態のサービスがハンドラー関数からまだ返されない場合、 ControlService は ERROR_SERVICE_REQUEST_TIMEOUTで失敗します。
サービスを停止して開始するには、それを可能にするセキュリティ記述子が必要です。 既定のセキュリティ記述子を使用すると、 LocalSystem アカウントと、Administrators グループと Power Users グループのメンバーがサービスを停止および開始できます。 サービスのセキュリティ記述子を変更するには、「サービス の DACL の変更」を参照してください。
QueryServiceStatusEx 関数は、dwCurrentState メンバーと dwControlsAccepted メンバーが、実行中のサービスによって受け入れられる現在の状態とコントロールを示すSERVICE_STATUS_PROCESS構造体を返します。 実行中のすべてのサービスは、既定で SERVICE_CONTROL_INTERROGATE 制御コードを受け入れます。 ドライバーは、SERVICE_CONTROL_STOPとSERVICE_CONTROL_INTERROGATE以外のコントロール コードを受け入れません。 各サービスは、 SetServiceStatus 関数を呼び出して状態を報告するときに受け入れる他のコントロール コードを指定します。 サービスは、何を行っていても、実行中にこれらのコードを常に受け入れる必要があります。
次の表は、使用可能な各サービス状態における SCM のアクションを示しています。
| サービスの状態 | Stop | その他の制御 |
|---|---|---|
| STOPPED | (c) | (c) |
| STOP_PENDING | (b) | (b) |
| START_PENDING | (a) | (b) |
| 実行 | (a) | (a) |
| CONTINUE_PENDING | (a) | (a) |
| PAUSE_PENDING | (a) | (a) |
| 一時 停止 | (a) | (a) |
- (a)
- サービスがこの制御コードを受け入れる場合は、サービスに要求を送信します。それ以外の場合、ControlService は 0 を返し、GetLastError はERROR_INVALID_SERVICE_CONTROLを返します。
- (b)
- サービスはコントロールを送信できる状態にないため、ControlService は 0 を返し、GetLastError はERROR_SERVICE_CANNOT_ACCEPT_CTRLを返します。
- (c)
- サービスはアクティブでないため、ControlService は 0 を返し、GetLastError はERROR_SERVICE_NOT_ACTIVEを返します。
例
例については、「 サービスの停止」を参照してください。
要件
| 要件 | 値 |
|---|---|
| サポートされている最小のクライアント | Windows XP (デスクトップ アプリのみ) |
| サポートされている最小のサーバー | Windows Server 2003 (デスクトップ アプリのみ) |
| 対象プラットフォーム | Windows |
| ヘッダー | winsvc.h (Windows.h を含む) |
| Library | AdvApi32.lib |
| [DLL] | AdvApi32.dll |