ホーム › System.Services › EnumDependentServicesA

EnumDependentServicesA

関数

指定サービスに依存するサービスを列挙する。

DLLADVAPI32.dll文字セットANSI (-A)呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL EnumDependentServicesA(
    SC_HANDLE hService,
    ENUM_SERVICE_STATE dwServiceState,
    ENUM_SERVICE_STATUSA* lpServices,   // optional
    DWORD cbBufSize,
    DWORD* pcbBytesNeeded,
    DWORD* lpServicesReturned
);

パラメーター

名前

型

方向

説明

hService

SC_HANDLE

サービスへのハンドル。このハンドルは OpenService または CreateService 関数によって返され、SERVICE_ENUMERATE_DEPENDENTS アクセス権を持っている必要があります。詳細については、 Service Security and Access Rights を参照してください。

dwServiceState

ENUM_SERVICE_STATE

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

値	意味
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。

lpServices

ENUM_SERVICE_STATUSA*

outoptional

データベース内の各依存サービスの名前とサービス状態情報を受け取る ENUM_SERVICE_STATUS 構造体の配列へのポインター。バッファーは、これらの構造体と、そのメンバーが指す文字列を格納できる大きさである必要があります。

この配列内のサービスの順序は、サービスの開始順序とは逆順です。つまり、配列の最初のサービスは最後に開始されるもの、配列の最後のサービスは最初に開始されるものになります。

この配列の最大サイズは 64,000 バイトです。必要なサイズを確認するには、このパラメーターに NULL を、cbBufSize パラメーターに 0 を指定します。関数は失敗し、GetLastError は ERROR_MORE_DATA を返します。必要なサイズは pcbBytesNeeded パラメーターに格納されます。

cbBufSize

DWORD

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

pcbBytesNeeded

DWORD*

out

サービスエントリの配列を格納するために必要なバイト数を受け取る変数へのポインター。この値が変数に格納されるのは、lpServices が指すバッファーが小さすぎる場合(関数の失敗と ERROR_MORE_DATA エラーによって示される)のみです。それ以外の場合、pcbBytesNeeded の内容は未定義です。

lpServicesReturned

DWORD*

out

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

戻り値の型: BOOL

公式ドキュメント

指定したサービスに依存している各サービスの名前と状態を取得します。(ANSI)

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 になります。拡張エラー情報を取得するには、 GetLastError を呼び出します。

次のエラーコードはサービス制御マネージャーによって設定される場合があります。それ以外のエラーコードは、サービス制御マネージャーによって呼び出されるレジストリ関数によって設定される場合があります。

戻りコード	説明
ERROR_ACCESS_DENIED	ハンドルに SERVICE_ENUMERATE_DEPENDENTS アクセス権がありません。
ERROR_INVALID_HANDLE	指定されたハンドルが無効です。
ERROR_INVALID_PARAMETER	指定されたパラメーターが無効です。
ERROR_MORE_DATA	lpServices が指すバッファーが十分な大きさではありません。関数は、lpServicesReturned が指す変数に、バッファーに格納されたサービスエントリの実際の数を設定します。また、pcbBytesNeeded が指す変数に、すべてのサービスエントリを格納するために必要なバイト数を設定します。

解説(Remarks)

返されるサービスエントリは、グループ順序を考慮したうえで、開始順序とは逆順に並べられます。依存サービスを停止する必要がある場合は、lpServices バッファーに書き込まれたエントリの順序を利用して、依存サービスを適切な順序で停止できます。

例

例については、 Stopping a Service を参照してください。

メモ

winsvc.h ヘッダーは EnumDependentServices をエイリアスとして定義しており、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択します。エンコーディングに依存しないこのエイリアスの使用と、エンコーディングに依存しないわけではないコードを混在させると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// ADVAPI32.dll  (ANSI / -A)
#include <windows.h>

BOOL EnumDependentServicesA(
    SC_HANDLE hService,
    ENUM_SERVICE_STATE dwServiceState,
    ENUM_SERVICE_STATUSA* lpServices,   // optional
    DWORD cbBufSize,
    DWORD* pcbBytesNeeded,
    DWORD* lpServicesReturned
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true, ExactSpelling = true)]
static extern bool EnumDependentServicesA(
    IntPtr hService,   // SC_HANDLE
    uint dwServiceState,   // ENUM_SERVICE_STATE
    IntPtr lpServices,   // ENUM_SERVICE_STATUSA* optional, out
    uint cbBufSize,   // DWORD
    out uint pcbBytesNeeded,   // DWORD* out
    out uint lpServicesReturned   // DWORD* out
);

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function EnumDependentServicesA(
    hService As IntPtr,   ' SC_HANDLE
    dwServiceState As UInteger,   ' ENUM_SERVICE_STATE
    lpServices As IntPtr,   ' ENUM_SERVICE_STATUSA* optional, out
    cbBufSize As UInteger,   ' DWORD
    <Out> ByRef pcbBytesNeeded As UInteger,   ' DWORD* out
    <Out> ByRef lpServicesReturned As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hService : SC_HANDLE
' dwServiceState : ENUM_SERVICE_STATE
' lpServices : ENUM_SERVICE_STATUSA* optional, out
' cbBufSize : DWORD
' pcbBytesNeeded : DWORD* out
' lpServicesReturned : DWORD* out
Declare PtrSafe Function EnumDependentServicesA Lib "advapi32" ( _
    ByVal hService As LongPtr, _
    ByVal dwServiceState As Long, _
    ByVal lpServices As LongPtr, _
    ByVal cbBufSize As Long, _
    ByRef pcbBytesNeeded As Long, _
    ByRef lpServicesReturned As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

EnumDependentServicesA = ctypes.windll.advapi32.EnumDependentServicesA
EnumDependentServicesA.restype = wintypes.BOOL
EnumDependentServicesA.argtypes = [
    wintypes.HANDLE,  # hService : SC_HANDLE
    wintypes.DWORD,  # dwServiceState : ENUM_SERVICE_STATE
    ctypes.c_void_p,  # lpServices : ENUM_SERVICE_STATUSA* optional, out
    wintypes.DWORD,  # cbBufSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbBytesNeeded : DWORD* out
    ctypes.POINTER(wintypes.DWORD),  # lpServicesReturned : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
EnumDependentServicesA = Fiddle::Function.new(
  lib['EnumDependentServicesA'],
  [
    Fiddle::TYPE_VOIDP,  # hService : SC_HANDLE
    -Fiddle::TYPE_INT,  # dwServiceState : ENUM_SERVICE_STATE
    Fiddle::TYPE_VOIDP,  # lpServices : ENUM_SERVICE_STATUSA* optional, out
    -Fiddle::TYPE_INT,  # cbBufSize : DWORD
    Fiddle::TYPE_VOIDP,  # pcbBytesNeeded : DWORD* out
    Fiddle::TYPE_VOIDP,  # lpServicesReturned : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn EnumDependentServicesA(
        hService: *mut core::ffi::c_void,  // SC_HANDLE
        dwServiceState: u32,  // ENUM_SERVICE_STATE
        lpServices: *mut ENUM_SERVICE_STATUSA,  // ENUM_SERVICE_STATUSA* optional, out
        cbBufSize: u32,  // DWORD
        pcbBytesNeeded: *mut u32,  // DWORD* out
        lpServicesReturned: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool EnumDependentServicesA(IntPtr hService, uint dwServiceState, IntPtr lpServices, uint cbBufSize, out uint pcbBytesNeeded, out uint lpServicesReturned);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_EnumDependentServicesA' -Namespace Win32 -PassThru
# $api::EnumDependentServicesA(hService, dwServiceState, lpServices, cbBufSize, pcbBytesNeeded, lpServicesReturned)

#uselib "ADVAPI32.dll"
#func global EnumDependentServicesA "EnumDependentServicesA" sptr, sptr, sptr, sptr, sptr, sptr
; EnumDependentServicesA hService, dwServiceState, varptr(lpServices), cbBufSize, varptr(pcbBytesNeeded), varptr(lpServicesReturned)   ; 戻り値は stat
; hService : SC_HANDLE -> "sptr"
; dwServiceState : ENUM_SERVICE_STATE -> "sptr"
; lpServices : ENUM_SERVICE_STATUSA* optional, out -> "sptr"
; cbBufSize : DWORD -> "sptr"
; pcbBytesNeeded : DWORD* out -> "sptr"
; lpServicesReturned : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ADVAPI32.dll"
#cfunc global EnumDependentServicesA "EnumDependentServicesA" sptr, int, var, int, var, var
; res = EnumDependentServicesA(hService, dwServiceState, lpServices, cbBufSize, pcbBytesNeeded, lpServicesReturned)
; hService : SC_HANDLE -> "sptr"
; dwServiceState : ENUM_SERVICE_STATE -> "int"
; lpServices : ENUM_SERVICE_STATUSA* optional, out -> "var"
; cbBufSize : DWORD -> "int"
; pcbBytesNeeded : DWORD* out -> "var"
; lpServicesReturned : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ADVAPI32.dll"
#cfunc global EnumDependentServicesA "EnumDependentServicesA" sptr, int, sptr, int, sptr, sptr
; res = EnumDependentServicesA(hService, dwServiceState, varptr(lpServices), cbBufSize, varptr(pcbBytesNeeded), varptr(lpServicesReturned))
; hService : SC_HANDLE -> "sptr"
; dwServiceState : ENUM_SERVICE_STATE -> "int"
; lpServices : ENUM_SERVICE_STATUSA* optional, out -> "sptr"
; cbBufSize : DWORD -> "int"
; pcbBytesNeeded : DWORD* out -> "sptr"
; lpServicesReturned : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。