EcDeleteSubscription function

The EcDeleteSubscription function deletes an existing subscription that is specified by the SubscriptionName parameter. The function fails if the security descriptor of the subscription does not permit delete access for the calling process. If the subscription is active at the moment this API is called, then the subscription is deactivated.

Syntax


BOOL WINAPI EcDeleteSubscription(
  _In_ LPCWSTR SubscriptionName,
  _In_ DWORD   Flags
);

Parameters

SubscriptionName [in]

The subscription to be deleted.

Flags [in]

Reserved, must be 0.

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 EcDeleteSubscription function, see Deleting an Event Collector 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: