EcInsertObjectArrayElement function (evcoll.h)

The EcInsertObjectArrayElement function inserts an empty object into an array of property values for the event sources of a subscription. The object is inserted at a specified array index.

Syntax

BOOL EcInsertObjectArrayElement(
  [in] EC_OBJECT_ARRAY_PROPERTY_HANDLE ObjectArray,
  [in] DWORD                           ArrayIndex
);

Parameters

[in] ObjectArray

A handle to the array in which the object is inserted into. 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] ArrayIndex

An array index indicating where to insert the object.

Return value

This function returns BOOL.

Remarks

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

Use the EcSetObjectArrayProperty to set individual properties of an empty object inserted into the array specified in the ObjectArray parameter.

Examples

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

Requirements

See also

Windows Event Collector Functions