EcRetrySubscription function

The EcRetrySubscription function is used to retry connecting to the event source of a subscription that is not connected.

Syntax


BOOL WINAPI EcRetrySubscription(
  _In_ LPCWSTR SubscriptionName,
  _In_ LPCWSTR EventSourceName,
  _In_ DWORD   Flags
);

Parameters

SubscriptionName [in]

The name of the subscription to which to connect.

EventSourceName [in]

The name of the event source of the subscription. This parameter is optional and can be NULL. This parameter must be NULL when the subscription is source initiated. If this parameter is NULL, the entire subscription will be retried.

Flags [in]

Reserved. Must be NULL.

Return value

TRUE

The function was successful.

FALSE

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

Remarks

To retry a subscription for all the event sources of a subscription, use the EcSaveSubscription function instead of calling EcRetrySubscription on each event source individually.

Examples

For example code using the EcRetrySubscription function, see Retrying 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: