EnumServicesStatusA 関数 (winsvc.h)

  • [アーティクル]

指定したサービス コントロール マネージャー データベース内のサービスを列挙します。 各サービスの名前と状態が指定されます。

この関数は EnumServicesStatusEx 関数に置き換えられます。 EnumServicesStatus から返されるのと同じ情報と、サービスのプロセス識別子と追加情報が返されます。 さらに、 EnumServicesStatusEx を使用すると、指定したグループに属するサービスを列挙できます。

構文

BOOL EnumServicesStatusA(
  [in]                SC_HANDLE              hSCManager,
  [in]                DWORD                  dwServiceType,
  [in]                DWORD                  dwServiceState,
  [out, optional]     LPENUM_SERVICE_STATUSA lpServices,
  [in]                DWORD                  cbBufSize,
  [out]               LPDWORD                pcbBytesNeeded,
  [out]               LPDWORD                lpServicesReturned,
  [in, out, optional] LPDWORD                lpResumeHandle
);

パラメーター

[in] hSCManager

サービス コントロール マネージャー データベースへのハンドル。 このハンドルは OpenSCManager 関数によって返され、SC_MANAGER_ENUMERATE_SERVICEアクセス権が必要です。 詳細については、「 サービス セキュリティとアクセス権」を参照してください。

[in] dwServiceType

列挙するサービスの種類。 このパラメーターには、次の 1 つ以上の値を指定できます。

値 説明
SERVICE_DRIVER
0x0000000B
 SERVICE_KERNEL_DRIVER型とSERVICE_FILE_SYSTEM_DRIVER型のサービス。
SERVICE_FILE_SYSTEM_DRIVER
0x00000002
 ファイル システム ドライバー サービス。
SERVICE_KERNEL_DRIVER
0x00000001
 ドライバー サービス。
SERVICE_WIN32
0x00000030
 SERVICE_WIN32_OWN_PROCESS型とSERVICE_WIN32_SHARE_PROCESS型のサービス。
SERVICE_WIN32_OWN_PROCESS
0x00000010
 独自のプロセスで実行されるサービス。
SERVICE_WIN32_SHARE_PROCESS
0x00000020
 プロセスを 1 つ以上の他のサービスと共有するサービス。 詳細については、「 サービス プログラム」を参照してください。

[in] dwServiceState

列挙するサービスの状態。 このパラメーターには、次の値のいずれかを指定できます。

値 説明
SERVICE_ACTIVE
0x00000001
 SERVICE_START_PENDING、SERVICE_STOP_PENDING、SERVICE_RUNNING、SERVICE_CONTINUE_PENDING、SERVICE_PAUSE_PENDING、SERVICE_PAUSEDの各状態のサービスを列挙します。
SERVICE_INACTIVE
0x00000002
 SERVICE_STOPPED状態のサービスを列挙します。
SERVICE_STATE_ALL
0x00000003
 SERVICE_ACTIVEとSERVICE_INACTIVEの状態を組み合わせます。

[out, optional] lpServices

データベース内の各サービスの名前とサービス状態情報 を 受け取るENUM_SERVICE_STATUS構造体の配列を含むバッファーへのポインター。 バッファーは、構造体とメンバーが指す文字列を保持するのに十分な大きさである必要があります。

この配列の最大サイズは 256K バイトです。 必要なサイズを決定するには、このパラメーターに NULL を指定し、 cbBufSize パラメーターに 0 を指定します。 関数は失敗し、 GetLastError はERROR_INSUFFICIENT_BUFFERを返します。 pcbBytesNeeded パラメーターは、必要なサイズを受け取ります。

Windows Server 2003 および Windows XP: この配列の最大サイズは 64K バイトです。 この制限は、Windows Server 2003 SP1 と Windows XP SP2 の時点で引き上げられました。

[in] cbBufSize

lpServices パラメーターが指すバッファーのサイズ (バイト単位)。

[out] pcbBytesNeeded

バッファーが小さすぎる場合に、残りのサービス エントリを返すために必要なバイト数を受け取る変数へのポインター。

[out] lpServicesReturned

返されるサービス エントリの数を受け取る変数へのポインター。

[in, out, optional] lpResumeHandle

入力時に列挙の開始点を指定する変数へのポインター。 この関数を初めて呼び出す場合は、この値を 0 に設定する必要があります。 出力時に、関数が成功した場合、この値は 0 になります。 ただし、関数が 0 を返し、 GetLastError 関数がERROR_MORE_DATAを返す場合、この値を使用して、追加データを取得するために関数が呼び出されたときに読み取られる次のサービス エントリを示します。

戻り値

関数が成功すると、戻り値は 0 以外になります。

関数が失敗した場合は、0 を返します。 詳細なエラー情報を得るには、GetLastError を呼び出します。

サービス コントロール マネージャーでは、次のエラー コードを設定できます。 その他のエラー コードは、サービス コントロール マネージャーによって呼び出されるレジストリ関数によって設定できます。

リターン コード 説明
ERROR_ACCESS_DENIED
 ハンドルには、SC_MANAGER_ENUMERATE_SERVICEアクセス権がありません。
ERROR_INVALID_HANDLE
 指定されたハンドルが無効です。
ERROR_INVALID_PARAMETER
 指定されたパラメーターが無効です。
ERROR_MORE_DATA
 lpServices バッファーに収まるよりも多くのサービス エントリがあります。 lpServices に書き込まれたサービス エントリの実際の数は、lpServicesReturned パラメーターで返されます。 残りのエントリを取得するために必要なバイト数は 、pcbBytesNeeded パラメーターで返されます。 残りのサービスは、読み取る次のサービスを示す lpResumeHandle パラメーターを使用して EnumServicesStatus を追加で呼び出すことによって列挙できます。

解説

注意

winsvc.h ヘッダーは EnumServicesStatus をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

   
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows Server 2003 (デスクトップ アプリのみ)
対象プラットフォーム Windows
ヘッダー winsvc.h (Windows.h を含む)
Library Advapi32.lib
[DLL] Advapi32.dll

関連項目

ENUM_SERVICE_STATUS

EnumDependentServices

EnumServicesStatusEx

OpenSCManager

サービス関数

サービスのインストール、削除、および列挙