ホーム › System.Services › QueryServiceConfigA

QueryServiceConfigA

関数

サービスの構成情報を取得する。

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

シグネチャ

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

BOOL QueryServiceConfigA(
    SC_HANDLE hService,
    QUERY_SERVICE_CONFIGA* lpServiceConfig,   // optional
    DWORD cbBufSize,
    DWORD* pcbBytesNeeded
);

パラメーター

名前	型	方向	説明
hService	SC_HANDLE	in	サービスへのハンドル。このハンドルは OpenService または CreateService 関数によって返され、SERVICE_QUERY_CONFIG アクセス権を持っている必要があります。詳細については、 Service Security and Access Rights を参照してください。
lpServiceConfig	QUERY_SERVICE_CONFIGA*	outoptional	サービス構成情報を受け取るバッファーへのポインター。データの形式は QUERY_SERVICE_CONFIG 構造体です。この配列の最大サイズは 8K バイトです。必要なサイズを判別するには、このパラメーターに NULL を、cbBufSize パラメーターに 0 を指定します。関数は失敗し、GetLastError は ERROR_INSUFFICIENT_BUFFER を返します。必要なサイズは pcbBytesNeeded パラメーターで受け取られます。
cbBufSize	DWORD	in	lpServiceConfig パラメーターが指すバッファーのサイズ(バイト単位)。
pcbBytesNeeded	DWORD*	out	関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合に、すべての構成情報を格納するために必要なバイト数を受け取る変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定したサービスの構成パラメーターを取得します。(ANSI)

戻り値

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

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

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

戻りコード	説明
ERROR_ACCESS_DENIED	ハンドルが SERVICE_QUERY_CONFIG アクセス権を持っていません。
ERROR_INSUFFICIENT_BUFFER	lpServiceConfig バッファーに収まる量を超えるサービス構成情報があります。すべての情報を取得するために必要なバイト数は pcbBytesNeeded パラメーターで返されます。lpServiceConfig には何も書き込まれません。
ERROR_INVALID_HANDLE	指定したハンドルが無効です。

解説(Remarks)

QueryServiceConfig 関数は、特定のサービスについてレジストリに保持されているサービス構成情報を返します。この構成情報は、まずサービス制御プログラムが CreateService 関数を使用して設定します。この情報は、サービス構成プログラムが ChangeServiceConfig 関数を使用して更新している場合があります。

構成情報が最後に変更された時点でサービスが実行中であった場合、 QueryServiceConfig が返す情報は、サービスの現在の構成を反映しません。代わりに、次回サービスが実行されるときの構成を反映します。ただし、DisplayName キーはこの例外です。DisplayName キーが変更されると、サービスが実行中かどうかにかかわらず、即座に有効になります。

例

例については、 Querying a Service's Configuration を参照してください。

メモ

winsvc.h ヘッダーは QueryServiceConfig をエイリアスとして定義しており、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 QueryServiceConfigA(
    SC_HANDLE hService,
    QUERY_SERVICE_CONFIGA* lpServiceConfig,   // optional
    DWORD cbBufSize,
    DWORD* pcbBytesNeeded
);

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

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

' hService : SC_HANDLE
' lpServiceConfig : QUERY_SERVICE_CONFIGA* optional, out
' cbBufSize : DWORD
' pcbBytesNeeded : DWORD* out
Declare PtrSafe Function QueryServiceConfigA Lib "advapi32" ( _
    ByVal hService As LongPtr, _
    ByVal lpServiceConfig 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

QueryServiceConfigA = ctypes.windll.advapi32.QueryServiceConfigA
QueryServiceConfigA.restype = wintypes.BOOL
QueryServiceConfigA.argtypes = [
    wintypes.HANDLE,  # hService : SC_HANDLE
    ctypes.c_void_p,  # lpServiceConfig : QUERY_SERVICE_CONFIGA* 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')
QueryServiceConfigA = Fiddle::Function.new(
  lib['QueryServiceConfigA'],
  [
    Fiddle::TYPE_VOIDP,  # hService : SC_HANDLE
    Fiddle::TYPE_VOIDP,  # lpServiceConfig : QUERY_SERVICE_CONFIGA* optional, out
    -Fiddle::TYPE_INT,  # cbBufSize : DWORD
    Fiddle::TYPE_VOIDP,  # pcbBytesNeeded : DWORD* out
  ],
  Fiddle::TYPE_INT)

#[link(name = "advapi32")]
extern "system" {
    fn QueryServiceConfigA(
        hService: *mut core::ffi::c_void,  // SC_HANDLE
        lpServiceConfig: *mut QUERY_SERVICE_CONFIGA,  // QUERY_SERVICE_CONFIGA* 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", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool QueryServiceConfigA(IntPtr hService, IntPtr lpServiceConfig, uint cbBufSize, out uint pcbBytesNeeded);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_QueryServiceConfigA' -Namespace Win32 -PassThru
# $api::QueryServiceConfigA(hService, lpServiceConfig, cbBufSize, pcbBytesNeeded)

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

出力引数:

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