EcEnumNextSubscription function

The EcEnumNextSubscription function continues the enumeration of the subscriptions registered on the local machine.

Syntax


BOOL WINAPI EcEnumNextSubscription(
  _In_  EC_HANDLE SubscriptionEnum,
  _In_  DWORD     SubscriptionNameBufferSize,
  _In_  LPWSTR    SubscriptionNameBuffer,
  _Out_ PDWORD    SubscriptionNameBufferUsed
);

Parameters

SubscriptionEnum [in]

The handle to the enumerator object that is returned from the EcOpenSubscriptionEnum function.

SubscriptionNameBufferSize [in]

The size of the user-supplied buffer (in chars) to store the subscription name.

SubscriptionNameBuffer [in]

The user-supplied buffer to store the subscription name.

SubscriptionNameBufferUsed [out]

The size of the user-supplied buffer that is used by the function on successful return, or the size that is necessary to store the subscription name when the function fails with ERROR_INSUFFICIENT_BUFFER.

Return value

TRUE

The function was successful.

FALSE

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

Examples

For example code using the EcEnumNextSubscription function, see Listing Event Collector Subscriptions.

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: