ホーム › System.Services › QueryServiceStatusEx

QueryServiceStatusEx

関数

指定サービスの拡張された状態情報を取得する。

DLLADVAPI32.dll呼出規約winapiSetLastErrorあり対応OSWindows XP 以降

シグネチャ

// ADVAPI32.dll
#include <windows.h>

BOOL QueryServiceStatusEx(
    SC_HANDLE hService,
    SC_STATUS_TYPE InfoLevel,
    BYTE* lpBuffer,   // optional
    DWORD cbBufSize,
    DWORD* pcbBytesNeeded
);

パラメーター

名前	型	方向	説明
hService	SC_HANDLE	in	サービスへのハンドル。このハンドルは CreateService 関数または OpenService 関数によって返され、SERVICE_QUERY_STATUS アクセス権を持っている必要があります。詳細については、 Service Security and Access Rights を参照してください。
InfoLevel	SC_STATUS_TYPE	in	返されるサービス属性。サービスの状態情報を取得するには SC_STATUS_PROCESS_INFO を使用します。この場合、lpBuffer パラメーターは SERVICE_STATUS_PROCESS 構造体へのポインターです。現在のところ、他の情報レベルは定義されていません。
lpBuffer	BYTE*	outoptional	状態情報を受け取るバッファーへのポインター。このデータの形式は InfoLevel パラメーターの値に依存します。この配列の最大サイズは 8K バイトです。必要なサイズを確認するには、このパラメーターに NULL を、cbBufSize パラメーターに 0 を指定します。関数は失敗し、GetLastError は ERROR_INSUFFICIENT_BUFFER を返します。pcbBytesNeeded パラメーターには必要なサイズが格納されます。
cbBufSize	DWORD	in	lpBuffer パラメーターが指すバッファーのサイズ(バイト単位)。
pcbBytesNeeded	DWORD*	out	関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合に、すべての状態情報を格納するために必要なバイト数を受け取る変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定された情報レベルに基づいて、指定したサービスの現在の状態を取得します。

戻り値

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

関数が失敗した場合、戻り値は 0 です。拡張エラー情報を取得するには、 GetLastError を呼び出します。次のエラーが返される可能性があります。

戻りコード	説明
ERROR_INVALID_HANDLE	ハンドルが無効です。
ERROR_ACCESS_DENIED	ハンドルが SERVICE_QUERY_STATUS アクセス権を持っていません。
ERROR_INSUFFICIENT_BUFFER	バッファーが SERVICE_STATUS_PROCESS 構造体に対して小さすぎます。構造体には何も書き込まれませんでした。
ERROR_INVALID_PARAMETER	SERVICE_STATUS_PROCESS の cbSize メンバーが無効です。
ERROR_INVALID_LEVEL	InfoLevel パラメーターにサポートされていない値が含まれています。
ERROR_SHUTDOWN_IN_PROGRESS	システムがシャットダウン中です。この関数は呼び出せません。

解説(Remarks)

QueryServiceStatusEx 関数は、サービスコントロールマネージャーに報告された最新のサービス状態情報を返します。サービスが状態を変更した直後の場合、まだサービスコントロールマネージャーに更新が反映されていないことがあります。

SERVICE_STATUS_PROCESS 構造体で返されるプロセス識別子は、サービスの状態が SERVICE_RUNNING、SERVICE_PAUSE_PENDING、SERVICE_PAUSED、SERVICE_CONTINUE_PENDING のいずれかである場合に有効です。ただし、サービスが SERVICE_START_PENDING または SERVICE_STOP_PENDING の状態にある場合、プロセス識別子は有効でないことがあり、サービスが SERVICE_STOPPED の状態にある場合は決して有効ではありません。

例

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

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

各言語での呼び出し定義

// ADVAPI32.dll
#include <windows.h>

BOOL QueryServiceStatusEx(
    SC_HANDLE hService,
    SC_STATUS_TYPE InfoLevel,
    BYTE* lpBuffer,   // optional
    DWORD cbBufSize,
    DWORD* pcbBytesNeeded
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool QueryServiceStatusEx(
    IntPtr hService,   // SC_HANDLE
    int InfoLevel,   // SC_STATUS_TYPE
    IntPtr lpBuffer,   // BYTE* optional, out
    uint cbBufSize,   // DWORD
    out uint pcbBytesNeeded   // DWORD* out
);

<DllImport("ADVAPI32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function QueryServiceStatusEx(
    hService As IntPtr,   ' SC_HANDLE
    InfoLevel As Integer,   ' SC_STATUS_TYPE
    lpBuffer As IntPtr,   ' BYTE* optional, out
    cbBufSize As UInteger,   ' DWORD
    <Out> ByRef pcbBytesNeeded As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hService : SC_HANDLE
' InfoLevel : SC_STATUS_TYPE
' lpBuffer : BYTE* optional, out
' cbBufSize : DWORD
' pcbBytesNeeded : DWORD* out
Declare PtrSafe Function QueryServiceStatusEx Lib "advapi32" ( _
    ByVal hService As LongPtr, _
    ByVal InfoLevel As Long, _
    ByVal lpBuffer As LongPtr, _
    ByVal cbBufSize As Long, _
    ByRef pcbBytesNeeded As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

QueryServiceStatusEx = ctypes.windll.advapi32.QueryServiceStatusEx
QueryServiceStatusEx.restype = wintypes.BOOL
QueryServiceStatusEx.argtypes = [
    wintypes.HANDLE,  # hService : SC_HANDLE
    ctypes.c_int,  # InfoLevel : SC_STATUS_TYPE
    ctypes.POINTER(ctypes.c_ubyte),  # lpBuffer : BYTE* optional, out
    wintypes.DWORD,  # cbBufSize : DWORD
    ctypes.POINTER(wintypes.DWORD),  # pcbBytesNeeded : DWORD* out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ADVAPI32.dll')
QueryServiceStatusEx = Fiddle::Function.new(
  lib['QueryServiceStatusEx'],
  [
    Fiddle::TYPE_VOIDP,  # hService : SC_HANDLE
    Fiddle::TYPE_INT,  # InfoLevel : SC_STATUS_TYPE
    Fiddle::TYPE_VOIDP,  # lpBuffer : BYTE* optional, out
    -Fiddle::TYPE_INT,  # cbBufSize : DWORD
    Fiddle::TYPE_VOIDP,  # pcbBytesNeeded : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn QueryServiceStatusEx(
        hService: *mut core::ffi::c_void,  // SC_HANDLE
        InfoLevel: i32,  // SC_STATUS_TYPE
        lpBuffer: *mut u8,  // BYTE* optional, out
        cbBufSize: u32,  // DWORD
        pcbBytesNeeded: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ADVAPI32.dll", SetLastError = true)]
public static extern bool QueryServiceStatusEx(IntPtr hService, int InfoLevel, IntPtr lpBuffer, uint cbBufSize, out uint pcbBytesNeeded);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_QueryServiceStatusEx' -Namespace Win32 -PassThru
# $api::QueryServiceStatusEx(hService, InfoLevel, lpBuffer, cbBufSize, pcbBytesNeeded)

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

出力引数:

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