EcSetObjectArrayProperty function (evcoll.h)

Article
10/13/2021

The EcSetObjectArrayProperty function sets a property value in an array of property values for the event sources of a subscription.

Syntax

BOOL EcSetObjectArrayProperty(
  [in] EC_OBJECT_ARRAY_PROPERTY_HANDLE ObjectArray,
  [in] EC_SUBSCRIPTION_PROPERTY_ID     PropertyId,
  [in] DWORD                           ArrayIndex,
  [in] DWORD                           Flags,
  [in] PEC_VARIANT                     PropertyValue
);

Parameters

[in] ObjectArray

A handle to the array that contains the property value to set. The array contains property values for the event sources of a subscription. The array handle is returned by the EcGetSubscriptionProperty method when the EcSubscriptionEventSources value is passed into the Subscription parameter.

[in] PropertyId

An identifier that specifies which property to set. Specify a value from the EC_SUBSCRIPTION_PROPERTY_ID enumeration. Set the Address, Enabled, UserName, and Password properties in the array by specifying the EcSubscriptionEventSourceAddress, EcSubscriptionEventSourceEnabled, EcSubscriptionEventSourceUserName, or EcSubscriptionEventSourcePassword values.

[in] ArrayIndex

The index of the object in the array to set a property value on.

[in] Flags

Reserved. Must be 0.

[in] PropertyValue

The value of the property.

Return value

This function returns BOOL.

Remarks

Arrays are zero-based, so the index for the first item in the array is 0.

Examples

For example code using the EcSetObjectArrayProperty function, see Adding an Event Source to a Collector Initiated Subscription.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	evcoll.h
Library	Wecapi.lib
DLL	Wecapi.dll