Export (0) Print
Expand All
Expand Minimize

MI_SubscriptionDeliveryOptions_SetHeartbeatInterval function

Sets the heartbeat interval.

Syntax


MI_Result MI_SubscriptionDeliveryOptions_SetHeartbeatInterval(
  _Inout_  MI_SubscriptionDeliveryOptions *self,
  _In_     MI_Interval *value
);

Parameters

self [in, out]

A pointer to a MI_SubscriptionDeliveryOptions structure.

value [in]

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.

Return codeDescription
MI_RESULT_OK

The operation succeeded.

MI_RESULT_SERVER_LIMITS_EXCEEDED

There is not enough memory to complete the request.

MI_RESULT_INVALID_PARAMETER

One or more parameters passed to the function were not valid.

MI_RESULT_FAILED

A failure not covered by other MI_Result error 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

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Redistributable

Windows Management Framework 3.0 on Windows Server 2008 R2 with SP1, Windows 7 with SP1, and Windows Server 2008 with SP2

Header

Mi.h

See also

MI_SubscriptionDeliveryOptions
MI_Interval
MI_SubscriptionDeliveryOptions_GetDeliveryDestination
MI_SubscriptionDeliveryOptions_GetDeliveryPortNumber
MI_SubscriptionDeliveryOptions_GetDeliveryRetryAttempts
MI_SubscriptionDeliveryOptions_GetDeliveryRetryInterval
MI_SubscriptionDeliveryOptions_GetHeartbeatInterval
MI_SubscriptionDeliveryOptions_SetDeliveryDestination
MI_SubscriptionDeliveryOptions_SetDeliveryPortNumber
MI_SubscriptionDeliveryOptions_SetDeliveryRetryAttempts
MI_SubscriptionDeliveryOptions_SetDeliveryRetryInterval

 

 

Show:
© 2014 Microsoft