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 Vista |
| 最低受支持的服务器 | Windows Server 2008 |
| 目标平台 | Windows |
| 标头 | evcoll.h |
| Library | Wecapi.lib |
| DLL | Wecapi.dll |