Win32 API 日本語リファレンス
ホームSystem.EventCollector › EcGetSubscriptionProperty

EcGetSubscriptionProperty

関数
サブスクリプションのプロパティ値を取得する。
DLLWecApi.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

BOOL EcGetSubscriptionProperty(
    INT_PTR Subscription,
    EC_SUBSCRIPTION_PROPERTY_ID PropertyId,
    DWORD Flags,
    DWORD PropertyValueBufferSize,
    EC_VARIANT* PropertyValueBuffer,
    DWORD* PropertyValueBufferUsed
);

パラメーター

名前方向
SubscriptionINT_PTRin
PropertyIdEC_SUBSCRIPTION_PROPERTY_IDin
FlagsDWORDin
PropertyValueBufferSizeDWORDin
PropertyValueBufferEC_VARIANT*inout
PropertyValueBufferUsedDWORD*out

戻り値の型: BOOL

各言語での呼び出し定義

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

BOOL EcGetSubscriptionProperty(
    INT_PTR Subscription,
    EC_SUBSCRIPTION_PROPERTY_ID PropertyId,
    DWORD Flags,
    DWORD PropertyValueBufferSize,
    EC_VARIANT* PropertyValueBuffer,
    DWORD* PropertyValueBufferUsed
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WecApi.dll", ExactSpelling = true)]
static extern bool EcGetSubscriptionProperty(
    IntPtr Subscription,   // INT_PTR
    int PropertyId,   // EC_SUBSCRIPTION_PROPERTY_ID
    uint Flags,   // DWORD
    uint PropertyValueBufferSize,   // DWORD
    IntPtr PropertyValueBuffer,   // EC_VARIANT* in/out
    out uint PropertyValueBufferUsed   // DWORD* out
);
<DllImport("WecApi.dll", ExactSpelling:=True)>
Public Shared Function EcGetSubscriptionProperty(
    Subscription As IntPtr,   ' INT_PTR
    PropertyId As Integer,   ' EC_SUBSCRIPTION_PROPERTY_ID
    Flags As UInteger,   ' DWORD
    PropertyValueBufferSize As UInteger,   ' DWORD
    PropertyValueBuffer As IntPtr,   ' EC_VARIANT* in/out
    <Out> ByRef PropertyValueBufferUsed As UInteger   ' DWORD* out
) As Boolean
End Function
' Subscription : INT_PTR
' PropertyId : EC_SUBSCRIPTION_PROPERTY_ID
' Flags : DWORD
' PropertyValueBufferSize : DWORD
' PropertyValueBuffer : EC_VARIANT* in/out
' PropertyValueBufferUsed : DWORD* out
Declare PtrSafe Function EcGetSubscriptionProperty Lib "wecapi" ( _
    ByVal Subscription As LongPtr, _
    ByVal PropertyId As Long, _
    ByVal Flags As Long, _
    ByVal PropertyValueBufferSize As Long, _
    ByVal PropertyValueBuffer As LongPtr, _
    ByRef PropertyValueBufferUsed As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

EcGetSubscriptionProperty = ctypes.windll.wecapi.EcGetSubscriptionProperty
EcGetSubscriptionProperty.restype = wintypes.BOOL
EcGetSubscriptionProperty.argtypes = [
    ctypes.c_ssize_t,  # Subscription : INT_PTR
    ctypes.c_int,  # PropertyId : EC_SUBSCRIPTION_PROPERTY_ID
    wintypes.DWORD,  # Flags : DWORD
    wintypes.DWORD,  # PropertyValueBufferSize : DWORD
    ctypes.c_void_p,  # PropertyValueBuffer : EC_VARIANT* in/out
    ctypes.POINTER(wintypes.DWORD),  # PropertyValueBufferUsed : DWORD* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('WecApi.dll')
EcGetSubscriptionProperty = Fiddle::Function.new(
  lib['EcGetSubscriptionProperty'],
  [
    Fiddle::TYPE_INTPTR_T,  # Subscription : INT_PTR
    Fiddle::TYPE_INT,  # PropertyId : EC_SUBSCRIPTION_PROPERTY_ID
    -Fiddle::TYPE_INT,  # Flags : DWORD
    -Fiddle::TYPE_INT,  # PropertyValueBufferSize : DWORD
    Fiddle::TYPE_VOIDP,  # PropertyValueBuffer : EC_VARIANT* in/out
    Fiddle::TYPE_VOIDP,  # PropertyValueBufferUsed : DWORD* out
  ],
  Fiddle::TYPE_INT)
#[link(name = "wecapi")]
extern "system" {
    fn EcGetSubscriptionProperty(
        Subscription: isize,  // INT_PTR
        PropertyId: i32,  // EC_SUBSCRIPTION_PROPERTY_ID
        Flags: u32,  // DWORD
        PropertyValueBufferSize: u32,  // DWORD
        PropertyValueBuffer: *mut EC_VARIANT,  // EC_VARIANT* in/out
        PropertyValueBufferUsed: *mut u32  // DWORD* out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WecApi.dll")]
public static extern bool EcGetSubscriptionProperty(IntPtr Subscription, int PropertyId, uint Flags, uint PropertyValueBufferSize, IntPtr PropertyValueBuffer, out uint PropertyValueBufferUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WecApi_EcGetSubscriptionProperty' -Namespace Win32 -PassThru
# $api::EcGetSubscriptionProperty(Subscription, PropertyId, Flags, PropertyValueBufferSize, PropertyValueBuffer, PropertyValueBufferUsed)
#uselib "WecApi.dll"
#func global EcGetSubscriptionProperty "EcGetSubscriptionProperty" sptr, sptr, sptr, sptr, sptr, sptr
; EcGetSubscriptionProperty Subscription, PropertyId, Flags, PropertyValueBufferSize, varptr(PropertyValueBuffer), varptr(PropertyValueBufferUsed)   ; 戻り値は stat
; Subscription : INT_PTR -> "sptr"
; PropertyId : EC_SUBSCRIPTION_PROPERTY_ID -> "sptr"
; Flags : DWORD -> "sptr"
; PropertyValueBufferSize : DWORD -> "sptr"
; PropertyValueBuffer : EC_VARIANT* in/out -> "sptr"
; PropertyValueBufferUsed : DWORD* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "WecApi.dll"
#cfunc global EcGetSubscriptionProperty "EcGetSubscriptionProperty" sptr, int, int, int, var, var
; res = EcGetSubscriptionProperty(Subscription, PropertyId, Flags, PropertyValueBufferSize, PropertyValueBuffer, PropertyValueBufferUsed)
; Subscription : INT_PTR -> "sptr"
; PropertyId : EC_SUBSCRIPTION_PROPERTY_ID -> "int"
; Flags : DWORD -> "int"
; PropertyValueBufferSize : DWORD -> "int"
; PropertyValueBuffer : EC_VARIANT* in/out -> "var"
; PropertyValueBufferUsed : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL EcGetSubscriptionProperty(INT_PTR Subscription, EC_SUBSCRIPTION_PROPERTY_ID PropertyId, DWORD Flags, DWORD PropertyValueBufferSize, EC_VARIANT* PropertyValueBuffer, DWORD* PropertyValueBufferUsed)
#uselib "WecApi.dll"
#cfunc global EcGetSubscriptionProperty "EcGetSubscriptionProperty" intptr, int, int, int, var, var
; res = EcGetSubscriptionProperty(Subscription, PropertyId, Flags, PropertyValueBufferSize, PropertyValueBuffer, PropertyValueBufferUsed)
; Subscription : INT_PTR -> "intptr"
; PropertyId : EC_SUBSCRIPTION_PROPERTY_ID -> "int"
; Flags : DWORD -> "int"
; PropertyValueBufferSize : DWORD -> "int"
; PropertyValueBuffer : EC_VARIANT* in/out -> "var"
; PropertyValueBufferUsed : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	wecapi = windows.NewLazySystemDLL("WecApi.dll")
	procEcGetSubscriptionProperty = wecapi.NewProc("EcGetSubscriptionProperty")
)

// Subscription (INT_PTR), PropertyId (EC_SUBSCRIPTION_PROPERTY_ID), Flags (DWORD), PropertyValueBufferSize (DWORD), PropertyValueBuffer (EC_VARIANT* in/out), PropertyValueBufferUsed (DWORD* out)
r1, _, err := procEcGetSubscriptionProperty.Call(
	uintptr(Subscription),
	uintptr(PropertyId),
	uintptr(Flags),
	uintptr(PropertyValueBufferSize),
	uintptr(PropertyValueBuffer),
	uintptr(PropertyValueBufferUsed),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function EcGetSubscriptionProperty(
  Subscription: NativeInt;   // INT_PTR
  PropertyId: Integer;   // EC_SUBSCRIPTION_PROPERTY_ID
  Flags: DWORD;   // DWORD
  PropertyValueBufferSize: DWORD;   // DWORD
  PropertyValueBuffer: Pointer;   // EC_VARIANT* in/out
  PropertyValueBufferUsed: Pointer   // DWORD* out
): BOOL; stdcall;
  external 'WecApi.dll' name 'EcGetSubscriptionProperty';
result := DllCall("WecApi\EcGetSubscriptionProperty"
    , "Ptr", Subscription   ; INT_PTR
    , "Int", PropertyId   ; EC_SUBSCRIPTION_PROPERTY_ID
    , "UInt", Flags   ; DWORD
    , "UInt", PropertyValueBufferSize   ; DWORD
    , "Ptr", PropertyValueBuffer   ; EC_VARIANT* in/out
    , "Ptr", PropertyValueBufferUsed   ; DWORD* out
    , "Int")   ; return: BOOL
●EcGetSubscriptionProperty(Subscription, PropertyId, Flags, PropertyValueBufferSize, PropertyValueBuffer, PropertyValueBufferUsed) = DLL("WecApi.dll", "bool EcGetSubscriptionProperty(int, int, dword, dword, void*, void*)")
# 呼び出し: EcGetSubscriptionProperty(Subscription, PropertyId, Flags, PropertyValueBufferSize, PropertyValueBuffer, PropertyValueBufferUsed)
# Subscription : INT_PTR -> "int"
# PropertyId : EC_SUBSCRIPTION_PROPERTY_ID -> "int"
# Flags : DWORD -> "dword"
# PropertyValueBufferSize : DWORD -> "dword"
# PropertyValueBuffer : EC_VARIANT* in/out -> "void*"
# PropertyValueBufferUsed : DWORD* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。