EcGetObjectArraySize function

The EcGetObjectArraySize function is used to get the size (the number of indexes) of the array of property values for the event sources of a subscription.

Syntax


BOOL WINAPI EcGetObjectArraySize(
  _In_   EC_OBJECT_ARRAY_PROPERTY_HANDLE ObjectArray,
  _Out_  PDWORD ObjectArraySize
);

Parameters

ObjectArray [in]

A handle to the array from which to get the size. 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 PropertyId parameter.

ObjectArraySize [out]

The size of the array (the number of indexes).

Return value

Return code/valueDescription
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 EcGetObjectArraySize function, see Displaying the Properties of an Event Collector Subscription.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2008 [desktop apps only]

Redistributable

WinRM v1.1 (Windows Server 2003 R2 or Windows XP with SP2)

Header

Evcoll.h

Library

Wecapi.lib

DLL

Wecapi.dll

 

 

Community Additions

ADD
Show:
© 2014 Microsoft