IVMGuestOS::HeartbeatPercentage property

The HeartbeatPercentage property contains the percentage of expected heartbeats received over the past minute.

This property is read-only.

Syntax

HRESULT get_HeartbeatPercentage(
  [out] long *heartbeatPercentage
);

VB
VMGuestOS.HeartbeatPercentage( _ ByRef heartbeatPercentage _ )

Property value

The percentage of expected heartbeats received over the past minute.

This property value is read-only.

Error codes

Name	Meaning
S_OK	The operation was successful.
E_POINTER	heartbeatPercentage is NULL.
VM_E_VM_UNKNOWN	The configuration is unknown.
VM_E_VM_NOT_RUNNING	The virtual machine is not running.
VM_E_ADDITIONS_NOT_AVAIL	The virtual machine is not fully booted, Additions are not installed, or the installed version does not support this feature.
DISP_E_EXCEPTION	An unexpected error occurred.

Remarks

The Additions will send a periodic heartbeat to Virtual Server while the guest operating system is running. If the guest operating system is heavily loaded, it's possible that Virtual Server will receive fewer heartbeats than expected. If the heartbeat percentage drops to zero, it's possible that the guest operating system has stopped responding or has crashed. The virtual machine must be running (that is, fully booted and not shutting down) and Additions must be installed when this property is invoked.

Requirements

Product	Microsoft Virtual Server 2005 onWindows Server 2003
Download	Microsoft Virtual Server 2005 R2 SP1 Update onWindows Server 2008orWindows Server 2003
Header	VsComInterfaces.h

See also

IVMGuestOS