Win32 API 日本語リファレンス
ホームNetworkManagement.WindowsConnectionManager › WcmQueryProperty

WcmQueryProperty

関数
接続マネージャーのインターフェイスまたはプロファイルのプロパティを照会する。
DLLwcmapi.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD WcmQueryProperty(
    const GUID* pInterface,   // optional
    LPCWSTR strProfileName,   // optional
    WCM_PROPERTY Property,
    void* pReserved,   // optional
    DWORD* pdwDataSize,
    BYTE** ppData
);

パラメーター

名前方向
pInterfaceGUID*inoptional
strProfileNameLPCWSTRinoptional
PropertyWCM_PROPERTYin
pReservedvoid*optional
pdwDataSizeDWORD*out
ppDataBYTE**out

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD WcmQueryProperty(
    const GUID* pInterface,   // optional
    LPCWSTR strProfileName,   // optional
    WCM_PROPERTY Property,
    void* pReserved,   // optional
    DWORD* pdwDataSize,
    BYTE** ppData
);
[DllImport("wcmapi.dll", ExactSpelling = true)]
static extern uint WcmQueryProperty(
    IntPtr pInterface,   // GUID* optional
    [MarshalAs(UnmanagedType.LPWStr)] string strProfileName,   // LPCWSTR optional
    int Property,   // WCM_PROPERTY
    IntPtr pReserved,   // void* optional
    out uint pdwDataSize,   // DWORD* out
    IntPtr ppData   // BYTE** out
);
<DllImport("wcmapi.dll", ExactSpelling:=True)>
Public Shared Function WcmQueryProperty(
    pInterface As IntPtr,   ' GUID* optional
    <MarshalAs(UnmanagedType.LPWStr)> strProfileName As String,   ' LPCWSTR optional
    [Property] As Integer,   ' WCM_PROPERTY
    pReserved As IntPtr,   ' void* optional
    <Out> ByRef pdwDataSize As UInteger,   ' DWORD* out
    ppData As IntPtr   ' BYTE** out
) As UInteger
End Function
' pInterface : GUID* optional
' strProfileName : LPCWSTR optional
' Property : WCM_PROPERTY
' pReserved : void* optional
' pdwDataSize : DWORD* out
' ppData : BYTE** out
Declare PtrSafe Function WcmQueryProperty Lib "wcmapi" ( _
    ByVal pInterface As LongPtr, _
    ByVal strProfileName As LongPtr, _
    ByVal Property As Long, _
    ByVal pReserved As LongPtr, _
    ByRef pdwDataSize As Long, _
    ByVal ppData As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

WcmQueryProperty = ctypes.windll.wcmapi.WcmQueryProperty
WcmQueryProperty.restype = wintypes.DWORD
WcmQueryProperty.argtypes = [
    ctypes.c_void_p,  # pInterface : GUID* optional
    wintypes.LPCWSTR,  # strProfileName : LPCWSTR optional
    ctypes.c_int,  # Property : WCM_PROPERTY
    ctypes.POINTER(None),  # pReserved : void* optional
    ctypes.POINTER(wintypes.DWORD),  # pdwDataSize : DWORD* out
    ctypes.c_void_p,  # ppData : BYTE** out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('wcmapi.dll')
WcmQueryProperty = Fiddle::Function.new(
  lib['WcmQueryProperty'],
  [
    Fiddle::TYPE_VOIDP,  # pInterface : GUID* optional
    Fiddle::TYPE_VOIDP,  # strProfileName : LPCWSTR optional
    Fiddle::TYPE_INT,  # Property : WCM_PROPERTY
    Fiddle::TYPE_VOIDP,  # pReserved : void* optional
    Fiddle::TYPE_VOIDP,  # pdwDataSize : DWORD* out
    Fiddle::TYPE_VOIDP,  # ppData : BYTE** out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "wcmapi")]
extern "system" {
    fn WcmQueryProperty(
        pInterface: *const GUID,  // GUID* optional
        strProfileName: *const u16,  // LPCWSTR optional
        Property: i32,  // WCM_PROPERTY
        pReserved: *mut (),  // void* optional
        pdwDataSize: *mut u32,  // DWORD* out
        ppData: *mut *mut u8  // BYTE** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("wcmapi.dll")]
public static extern uint WcmQueryProperty(IntPtr pInterface, [MarshalAs(UnmanagedType.LPWStr)] string strProfileName, int Property, IntPtr pReserved, out uint pdwDataSize, IntPtr ppData);
"@
$api = Add-Type -MemberDefinition $sig -Name 'wcmapi_WcmQueryProperty' -Namespace Win32 -PassThru
# $api::WcmQueryProperty(pInterface, strProfileName, Property, pReserved, pdwDataSize, ppData)
#uselib "wcmapi.dll"
#func global WcmQueryProperty "WcmQueryProperty" sptr, sptr, sptr, sptr, sptr, sptr
; WcmQueryProperty varptr(pInterface), strProfileName, Property, pReserved, varptr(pdwDataSize), varptr(ppData)   ; 戻り値は stat
; pInterface : GUID* optional -> "sptr"
; strProfileName : LPCWSTR optional -> "sptr"
; Property : WCM_PROPERTY -> "sptr"
; pReserved : void* optional -> "sptr"
; pdwDataSize : DWORD* out -> "sptr"
; ppData : BYTE** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "wcmapi.dll"
#cfunc global WcmQueryProperty "WcmQueryProperty" var, wstr, int, sptr, var, var
; res = WcmQueryProperty(pInterface, strProfileName, Property, pReserved, pdwDataSize, ppData)
; pInterface : GUID* optional -> "var"
; strProfileName : LPCWSTR optional -> "wstr"
; Property : WCM_PROPERTY -> "int"
; pReserved : void* optional -> "sptr"
; pdwDataSize : DWORD* out -> "var"
; ppData : BYTE** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD WcmQueryProperty(GUID* pInterface, LPCWSTR strProfileName, WCM_PROPERTY Property, void* pReserved, DWORD* pdwDataSize, BYTE** ppData)
#uselib "wcmapi.dll"
#cfunc global WcmQueryProperty "WcmQueryProperty" var, wstr, int, intptr, var, var
; res = WcmQueryProperty(pInterface, strProfileName, Property, pReserved, pdwDataSize, ppData)
; pInterface : GUID* optional -> "var"
; strProfileName : LPCWSTR optional -> "wstr"
; Property : WCM_PROPERTY -> "int"
; pReserved : void* optional -> "intptr"
; pdwDataSize : DWORD* out -> "var"
; ppData : BYTE** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wcmapi = windows.NewLazySystemDLL("wcmapi.dll")
	procWcmQueryProperty = wcmapi.NewProc("WcmQueryProperty")
)

// pInterface (GUID* optional), strProfileName (LPCWSTR optional), Property (WCM_PROPERTY), pReserved (void* optional), pdwDataSize (DWORD* out), ppData (BYTE** out)
r1, _, err := procWcmQueryProperty.Call(
	uintptr(pInterface),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(strProfileName))),
	uintptr(Property),
	uintptr(pReserved),
	uintptr(pdwDataSize),
	uintptr(ppData),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function WcmQueryProperty(
  pInterface: PGUID;   // GUID* optional
  strProfileName: PWideChar;   // LPCWSTR optional
  Property: Integer;   // WCM_PROPERTY
  pReserved: Pointer;   // void* optional
  pdwDataSize: Pointer;   // DWORD* out
  ppData: Pointer   // BYTE** out
): DWORD; stdcall;
  external 'wcmapi.dll' name 'WcmQueryProperty';
result := DllCall("wcmapi\WcmQueryProperty"
    , "Ptr", pInterface   ; GUID* optional
    , "WStr", strProfileName   ; LPCWSTR optional
    , "Int", Property   ; WCM_PROPERTY
    , "Ptr", pReserved   ; void* optional
    , "Ptr", pdwDataSize   ; DWORD* out
    , "Ptr", ppData   ; BYTE** out
    , "UInt")   ; return: DWORD
●WcmQueryProperty(pInterface, strProfileName, Property, pReserved, pdwDataSize, ppData) = DLL("wcmapi.dll", "dword WcmQueryProperty(void*, char*, int, void*, void*, void*)")
# 呼び出し: WcmQueryProperty(pInterface, strProfileName, Property, pReserved, pdwDataSize, ppData)
# pInterface : GUID* optional -> "void*"
# strProfileName : LPCWSTR optional -> "char*"
# Property : WCM_PROPERTY -> "int"
# pReserved : void* optional -> "void*"
# pdwDataSize : DWORD* out -> "void*"
# ppData : BYTE** out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。