EcRemoveObjectArrayElement function (evcoll.h)

Article
02/22/2024

The EcRemoveObjectArrayElement function removes an element from an array of objects that contain property values for the event sources of a subscription.

Syntax

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

Parameters

[in] ObjectArray

A handle to the array in which to remove the element. 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

The index of the element to remove from the array.

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 EcRemoveObjectArrayElement function, see Removing an Event Source from 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

Share via