EcRetrySubscription function (evcoll.h)

Article
02/22/2024

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

Syntax

BOOL EcRetrySubscription(
  [in] LPCWSTR SubscriptionName,
  [in] LPCWSTR EventSourceName,
  [in] DWORD   Flags
);

Parameters

[in] SubscriptionName

The name of the subscription to which to connect.

[in] EventSourceName

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.

[in] Flags

Reserved. Must be NULL.

Return value

This function returns BOOL.

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

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Target Platform	Windows
Header	evcoll.h
Library	Wecapi.lib
DLL	Wecapi.dll