ホーム › System.Services › QueryServiceConfig2A

QueryServiceConfig2A

関数

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

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

シグネチャ

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

BOOL QueryServiceConfig2A(
    SC_HANDLE hService,
    SERVICE_CONFIG dwInfoLevel,
    BYTE* lpBuffer,   // optional
    DWORD cbBufSize,
    DWORD* pcbBytesNeeded
);

パラメーター

名前

型

方向

説明

hService

SC_HANDLE

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

dwInfoLevel

SERVICE_CONFIG

クエリする構成情報。このパラメーターには、次のいずれかの値を指定できます。

値	意味
SERVICE_CONFIG_DELAYED_AUTO_START_INFO 3	lpInfo パラメーターは SERVICE_DELAYED_AUTO_START_INFO 構造体へのポインターです。 Windows Server 2003 および Windows XP: この値はサポートされていません。
SERVICE_CONFIG_DESCRIPTION 1	lpBuffer パラメーターは SERVICE_DESCRIPTION 構造体へのポインターです。
SERVICE_CONFIG_FAILURE_ACTIONS 2	lpBuffer パラメーターは SERVICE_FAILURE_ACTIONS 構造体へのポインターです。
SERVICE_CONFIG_FAILURE_ACTIONS_FLAG 4	lpInfo パラメーターは SERVICE_FAILURE_ACTIONS_FLAG 構造体へのポインターです。 Windows Server 2003 および Windows XP: この値はサポートされていません。
SERVICE_CONFIG_PREFERRED_NODE 9	lpInfo パラメーターは SERVICE_PREFERRED_NODE_INFO 構造体へのポインターです。 Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: この値はサポートされていません。
SERVICE_CONFIG_PRESHUTDOWN_INFO 7	lpInfo パラメーターは SERVICE_PRESHUTDOWN_INFO 構造体へのポインターです。 Windows Server 2003 および Windows XP: この値はサポートされていません。
SERVICE_CONFIG_REQUIRED_PRIVILEGES_INFO 6	lpInfo パラメーターは SERVICE_REQUIRED_PRIVILEGES_INFO 構造体へのポインターです。 Windows Server 2003 および Windows XP: この値はサポートされていません。
SERVICE_CONFIG_SERVICE_SID_INFO 5	lpInfo パラメーターは SERVICE_SID_INFO 構造体へのポインターです。 Windows Server 2003 および Windows XP: この値はサポートされていません。
SERVICE_CONFIG_TRIGGER_INFO 8	lpInfo パラメーターは SERVICE_TRIGGER_INFO 構造体へのポインターです。 Windows Server 2008、Windows Vista、Windows Server 2003 および Windows XP: この値はサポートされていません。
SERVICE_CONFIG_LAUNCH_PROTECTED 12	lpInfo パラメーターは SERVICE_LAUNCH_PROTECTED_INFO 構造体へのポインターです。注意この値は Windows 8.1 以降でサポートされます。

lpBuffer

BYTE*

outoptional

サービス構成情報を受け取るバッファーへのポインター。このデータの形式は dwInfoLevel パラメーターの値によって異なります。

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

cbBufSize

DWORD

lpBuffer パラメーターが指す構造体のサイズ(バイト単位)。

pcbBytesNeeded

DWORD*

out

関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合に、構成情報を格納するために必要なバイト数を受け取る変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

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

戻り値

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

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

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

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

解説(Remarks)

QueryServiceConfig2 関数は、指定したサービスについてサービス制御マネージャーのデータベースに格納されているオプションの構成情報を返します。この構成情報は ChangeServiceConfig2 関数を使用して変更できます。

追加の構成情報の変更とクエリには、それぞれ ChangeServiceConfig 関数および QueryServiceConfig 関数を使用できます。

例

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

メモ

winsvc.h ヘッダーは QueryServiceConfig2 を、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 QueryServiceConfig2A(
    SC_HANDLE hService,
    SERVICE_CONFIG dwInfoLevel,
    BYTE* lpBuffer,   // optional
    DWORD cbBufSize,
    DWORD* pcbBytesNeeded
);

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

<DllImport("ADVAPI32.dll", CharSet:=CharSet.Ansi, SetLastError:=True, ExactSpelling:=True)>
Public Shared Function QueryServiceConfig2A(
    hService As IntPtr,   ' SC_HANDLE
    dwInfoLevel As UInteger,   ' SERVICE_CONFIG
    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
' dwInfoLevel : SERVICE_CONFIG
' lpBuffer : BYTE* optional, out
' cbBufSize : DWORD
' pcbBytesNeeded : DWORD* out
Declare PtrSafe Function QueryServiceConfig2A Lib "advapi32" ( _
    ByVal hService As LongPtr, _
    ByVal dwInfoLevel 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

QueryServiceConfig2A = ctypes.windll.advapi32.QueryServiceConfig2A
QueryServiceConfig2A.restype = wintypes.BOOL
QueryServiceConfig2A.argtypes = [
    wintypes.HANDLE,  # hService : SC_HANDLE
    wintypes.DWORD,  # dwInfoLevel : SERVICE_CONFIG
    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')
QueryServiceConfig2A = Fiddle::Function.new(
  lib['QueryServiceConfig2A'],
  [
    Fiddle::TYPE_VOIDP,  # hService : SC_HANDLE
    -Fiddle::TYPE_INT,  # dwInfoLevel : SERVICE_CONFIG
    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 QueryServiceConfig2A(
        hService: *mut core::ffi::c_void,  // SC_HANDLE
        dwInfoLevel: u32,  // SERVICE_CONFIG
        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", CharSet = CharSet.Ansi, SetLastError = true)]
public static extern bool QueryServiceConfig2A(IntPtr hService, uint dwInfoLevel, IntPtr lpBuffer, uint cbBufSize, out uint pcbBytesNeeded);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ADVAPI32_QueryServiceConfig2A' -Namespace Win32 -PassThru
# $api::QueryServiceConfig2A(hService, dwInfoLevel, lpBuffer, cbBufSize, pcbBytesNeeded)

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

出力引数:

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