MI_SubscriptionDeliveryOptions_SetHeartbeatInterval function (mi.h)

Article
10/13/2021

Sets the heartbeat interval.

Syntax

MI_INLINE MI_Result MI_SubscriptionDeliveryOptions_SetHeartbeatInterval(
  [in, out] MI_SubscriptionDeliveryOptions *self,
  [in]      MI_Interval                    *value
);

Parameters

[in, out] self

A pointer to a MI_SubscriptionDeliveryOptions structure.

[in] value

Interval between delivery of results whereby the server notifies the client that the server is still connected.

Return value

A value of the MI_Result enumeration that specifies the function return code. This can be one of the following codes.

Remarks

If no events are available, the server uses this interval to send a heartbeat back to the client so that the client knows that the server is still there. This function is relevant for push delivery.

Requirements

Requirement	Value
Minimum supported client	Windows 8
Minimum supported server	Windows Server 2012
Target Platform	Windows
Header	mi.h
Redistributable	Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2