EcGetObjectArrayProperty 関数 (evcoll.h)

  • [アーティクル]

EcGetObjectArrayProperty 関数は、イベント ソース プロパティの配列へのハンドルからプロパティ値を取得します。 配列には、サブスクリプションのイベント ソースのプロパティ値が含まれています。

構文

BOOL EcGetObjectArrayProperty(
  [in]  EC_OBJECT_ARRAY_PROPERTY_HANDLE ObjectArray,
  [in]  EC_SUBSCRIPTION_PROPERTY_ID     PropertyId,
  [in]  DWORD                           ArrayIndex,
  [in]  DWORD                           Flags,
  [in]  DWORD                           PropertyValueBufferSize,
  [in]  PEC_VARIANT                     PropertyValueBuffer,
  [out] PDWORD                          PropertyValueBufferUsed
);

パラメーター

[in] ObjectArray

サブスクリプションのイベント ソースのプロパティの配列へのハンドル。 EcSubscriptionEventSources 値が PropertyId パラメーターに渡されたときに EcGetSubscriptionProperty メソッドによって返される配列ハンドル。

[in] PropertyId

配列内のプロパティのプロパティ識別子。 EC_SUBSCRIPTION_PROPERTY_ID列挙の値を指定します。 EcSubscriptionEventSourceAddress、EcSubscriptionEventSourceEnabled、EcSubscriptionEventSourceUserName、または EcSubscriptionEventSourcePassword 値を指定して、配列内の Address、Enabled、UserName、Password の各プロパティを取得します。

[in] ArrayIndex

プロパティを取得するイベント ソースを指定する配列のインデックス。

[in] Flags

予約済み。 0 を指定する必要があります。

[in] PropertyValueBufferSize

プロパティの値を含むバッファーのサイズ。 サイズは、少なくとも EC_VARIANT 値のサイズである必要があります。

[in] PropertyValueBuffer

プロパティ値を格納するユーザー指定のバッファー。

[out] PropertyValueBufferUsed

正常に戻ったときに関数によって使用されるユーザー指定のバッファーのサイズ、または関数が ERROR_INSUFFICIENT_BUFFER で失敗したときにプロパティ値を格納するために必要なサイズ。

戻り値

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

注釈

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

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

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

例

EcGetObjectArrayProperty 関数を使用したコード例については、「イベント コレクター サブスクリプションのプロパティの表示」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows Vista
サポートされている最小のサーバー Windows Server 2008
対象プラットフォーム Windows
ヘッダー evcoll.h
Library Wecapi.lib
[DLL] Wecapi.dll

こちらもご覧ください

Windows イベント コレクター関数