SetHeartbeat method

Applies to

This method is called by a remote client as a request for regular "heartbeat" messages as an indication that the application is running. The remote clients' Dispatch interface (object handle) is provided in the Client parameter. The return value is 0 (zero) if the heartbeat was successful; otherwise it is a negative value.

When a call to the function has been made, the application starts receiving AppHeartBeat events at the intervals specified in the Interval parameter. The argument to the AppHeartBeat is the Client parameter. You can disable the AppHeartBeat events by calling this function with an Interval value of zero.

Return Type

Boolean

Syntax

object.SetHeartbeat( Object As Object, Interval As Long)

Related topic

Ping

Part

Description

object

An expression evaluating to an object listed in the 'Applies to' table above.

Object

Object

Interval

A long value.