EcRemoveObjectArrayElement function

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

Syntax


BOOL WINAPI EcRemoveObjectArrayElement(
  _In_ EC_OBJECT_ARRAY_PROPERTY_HANDLE ObjectArray,
  _In_ DWORD                           ArrayIndex
);

Parameters

ObjectArray [in]

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.

ArrayIndex [in]

The index of the element to remove from the array.

Return value

TRUE

The function was successful.

FALSE

The function failed. Use the GetLastError function to obtain the error code.

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

Minimum supported client

Windows Vista

Minimum supported server

Windows Server 2008

Header

Evcoll.h

Library

Wecapi.lib

DLL

Wecapi.dll

See also

Windows Event Collector Functions

 

 

Show: