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。

無法擷取事件來源或訂用帳戶的Password屬性。 基於安全性考慮，會針對 屬性值傳回空字串，並將最後一個錯誤設定為 ERROR_ACCESS_DENIED。

訂用帳戶可以有多個事件來源，而且每個來源都可以有 Address、 Enabled、 UserName 和 Password 屬性。

範例

如需使用 EcGetObjectArrayProperty 函式 的程式碼範例，請參閱 顯示事件收集器訂閱的屬性。

規格需求

另請參閱

Windows 事件收集器函式