EcClose function

The EcClose function closes a handle received from other Event Collector functions. Any handle returned by an event collector management API call must be closed using this call when the user is finished with the handle. The handle becomes invalid when this function is successfully called.

Syntax


BOOL WINAPI EcClose(
  _In_ EC_HANDLE Object
);

Parameters

Object [in]

A valid open handle returned from an event collector management API call.

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 EcClose 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: