ホーム › System.EventCollector › EcGetObjectArrayProperty

EcGetObjectArrayProperty

関数

オブジェクト配列要素のプロパティ値を取得する。

DLLWecApi.dll呼出規約winapi対応OSWindows Vista 以降

シグネチャ

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

BOOL EcGetObjectArrayProperty(
    INT_PTR ObjectArray,
    EC_SUBSCRIPTION_PROPERTY_ID PropertyId,
    DWORD ArrayIndex,
    DWORD Flags,
    DWORD PropertyValueBufferSize,
    EC_VARIANT* PropertyValueBuffer,
    DWORD* PropertyValueBufferUsed
);

パラメーター

名前	型	方向	説明
ObjectArray	INT_PTR	in	サブスクリプションのイベントソースのプロパティ配列へのハンドル。PropertyId パラメーターに EcSubscriptionEventSources 値を渡したときに EcGetSubscriptionProperty メソッドから返される配列ハンドルです。
PropertyId	EC_SUBSCRIPTION_PROPERTY_ID	in	配列内のプロパティのプロパティ識別子。EC_SUBSCRIPTION_PROPERTY_ID 列挙型の値を指定します。EcSubscriptionEventSourceAddress、EcSubscriptionEventSourceEnabled、EcSubscriptionEventSourceUserName、または EcSubscriptionEventSourcePassword の値を指定することで、配列内の Address、Enabled、UserName、Password の各プロパティを取得します。
ArrayIndex	DWORD	in	どのイベントソースからプロパティを取得するかを指定する、配列のインデックス。
Flags	DWORD	in	予約されています。0 を指定する必要があります。
PropertyValueBufferSize	DWORD	in	プロパティの値を格納するバッファーのサイズ。サイズは少なくとも EC_VARIANT 値のサイズ以上である必要があります。
PropertyValueBuffer	EC_VARIANT*	inout	プロパティ値を格納するための、ユーザーが用意したバッファー。
PropertyValueBufferUsed	DWORD*	out	関数が正常に終了した場合は、関数が使用したユーザー指定バッファーのサイズ。関数が ERROR_INSUFFICIENT_BUFFER で失敗した場合は、プロパティ値の格納に必要なサイズ。

戻り値の型: BOOL

公式ドキュメント

サブスクリプションのイベントソースのプロパティ値を取得します。

戻り値

この関数は BOOL を返します。

解説(Remarks)

配列は 0 から始まるため、配列内の最初の項目のインデックスは 0 です。

イベントソースまたはサブスクリプションの Password プロパティは取得できません。セキュリティ上の理由から、プロパティ値としては空の文字列が返され、最後のエラーは ERROR_ACCESS_DENIED に設定されます。

1 つのサブスクリプションは複数のイベントソースを持つことができ、各ソースは Address、Enabled、UserName、Password の各プロパティを持つことができます。

例

EcGetObjectArrayProperty 関数を使用するサンプルコードについては、「Displaying the Properties of an Event Collector Subscription」を参照してください。

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

各言語での呼び出し定義

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

BOOL EcGetObjectArrayProperty(
    INT_PTR ObjectArray,
    EC_SUBSCRIPTION_PROPERTY_ID PropertyId,
    DWORD ArrayIndex,
    DWORD Flags,
    DWORD PropertyValueBufferSize,
    EC_VARIANT* PropertyValueBuffer,
    DWORD* PropertyValueBufferUsed
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("WecApi.dll", ExactSpelling = true)]
static extern bool EcGetObjectArrayProperty(
    IntPtr ObjectArray,   // INT_PTR
    int PropertyId,   // EC_SUBSCRIPTION_PROPERTY_ID
    uint ArrayIndex,   // DWORD
    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 EcGetObjectArrayProperty(
    ObjectArray As IntPtr,   ' INT_PTR
    PropertyId As Integer,   ' EC_SUBSCRIPTION_PROPERTY_ID
    ArrayIndex As UInteger,   ' DWORD
    Flags As UInteger,   ' DWORD
    PropertyValueBufferSize As UInteger,   ' DWORD
    PropertyValueBuffer As IntPtr,   ' EC_VARIANT* in/out
    <Out> ByRef PropertyValueBufferUsed As UInteger   ' DWORD* out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' ObjectArray : INT_PTR
' PropertyId : EC_SUBSCRIPTION_PROPERTY_ID
' ArrayIndex : DWORD
' Flags : DWORD
' PropertyValueBufferSize : DWORD
' PropertyValueBuffer : EC_VARIANT* in/out
' PropertyValueBufferUsed : DWORD* out
Declare PtrSafe Function EcGetObjectArrayProperty Lib "wecapi" ( _
    ByVal ObjectArray As LongPtr, _
    ByVal PropertyId As Long, _
    ByVal ArrayIndex 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

EcGetObjectArrayProperty = ctypes.windll.wecapi.EcGetObjectArrayProperty
EcGetObjectArrayProperty.restype = wintypes.BOOL
EcGetObjectArrayProperty.argtypes = [
    ctypes.c_ssize_t,  # ObjectArray : INT_PTR
    ctypes.c_int,  # PropertyId : EC_SUBSCRIPTION_PROPERTY_ID
    wintypes.DWORD,  # ArrayIndex : DWORD
    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')
EcGetObjectArrayProperty = Fiddle::Function.new(
  lib['EcGetObjectArrayProperty'],
  [
    Fiddle::TYPE_INTPTR_T,  # ObjectArray : INT_PTR
    Fiddle::TYPE_INT,  # PropertyId : EC_SUBSCRIPTION_PROPERTY_ID
    -Fiddle::TYPE_INT,  # ArrayIndex : DWORD
    -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 EcGetObjectArrayProperty(
        ObjectArray: isize,  // INT_PTR
        PropertyId: i32,  // EC_SUBSCRIPTION_PROPERTY_ID
        ArrayIndex: u32,  // DWORD
        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 EcGetObjectArrayProperty(IntPtr ObjectArray, int PropertyId, uint ArrayIndex, uint Flags, uint PropertyValueBufferSize, IntPtr PropertyValueBuffer, out uint PropertyValueBufferUsed);
"@
$api = Add-Type -MemberDefinition $sig -Name 'WecApi_EcGetObjectArrayProperty' -Namespace Win32 -PassThru
# $api::EcGetObjectArrayProperty(ObjectArray, PropertyId, ArrayIndex, Flags, PropertyValueBufferSize, PropertyValueBuffer, PropertyValueBufferUsed)

#uselib "WecApi.dll"
#func global EcGetObjectArrayProperty "EcGetObjectArrayProperty" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; EcGetObjectArrayProperty ObjectArray, PropertyId, ArrayIndex, Flags, PropertyValueBufferSize, varptr(PropertyValueBuffer), varptr(PropertyValueBufferUsed)   ; 戻り値は stat
; ObjectArray : INT_PTR -> "sptr"
; PropertyId : EC_SUBSCRIPTION_PROPERTY_ID -> "sptr"
; ArrayIndex : DWORD -> "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 EcGetObjectArrayProperty "EcGetObjectArrayProperty" sptr, int, int, int, int, var, var
; res = EcGetObjectArrayProperty(ObjectArray, PropertyId, ArrayIndex, Flags, PropertyValueBufferSize, PropertyValueBuffer, PropertyValueBufferUsed)
; ObjectArray : INT_PTR -> "sptr"
; PropertyId : EC_SUBSCRIPTION_PROPERTY_ID -> "int"
; ArrayIndex : DWORD -> "int"
; Flags : DWORD -> "int"
; PropertyValueBufferSize : DWORD -> "int"
; PropertyValueBuffer : EC_VARIANT* in/out -> "var"
; PropertyValueBufferUsed : DWORD* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "WecApi.dll"
#cfunc global EcGetObjectArrayProperty "EcGetObjectArrayProperty" sptr, int, int, int, int, sptr, sptr
; res = EcGetObjectArrayProperty(ObjectArray, PropertyId, ArrayIndex, Flags, PropertyValueBufferSize, varptr(PropertyValueBuffer), varptr(PropertyValueBufferUsed))
; ObjectArray : INT_PTR -> "sptr"
; PropertyId : EC_SUBSCRIPTION_PROPERTY_ID -> "int"
; ArrayIndex : DWORD -> "int"
; Flags : DWORD -> "int"
; PropertyValueBufferSize : DWORD -> "int"
; PropertyValueBuffer : EC_VARIANT* in/out -> "sptr"
; PropertyValueBufferUsed : DWORD* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。