IVMGuestOS::HeartbeatPercentage property
[Windows Virtual PC is no longer available for use as of Windows 8. Instead, use the Hyper-V WMI provider (V2).]
Retrieves the percentage of expected heartbeats received over the past minute.
This property is read-only.
Syntax
HRESULT get_HeartbeatPercentage(
[out, retval] long *heartbeatPercentage
);
Property value
The percentage of expected heartbeats received over the past minute.
Error codes
| Name/value | Meaning |
|---|---|
|
The operation was successful. |
|
The parameter is NULL. |
|
The configuration is unknown. |
|
The virtual machine (VM) must be running for this operation. |
|
The VM is not fully booted, the integration components feature is not installed, or the installed version does not support this feature. |
|
An unexpected error has occurred. |
Remarks
Integration components will send a periodic heartbeat to Windows Virtual PC while the guest operating system is running. If the guest operating system is heavily loaded, it's possible that Windows Virtual PC will receive fewer heartbeats than expected. If the heartbeat percentage drops to zero, it is possible that the guest operating system is not responding or is crashed. The virtual machine must be running (that is, fully booted and not shutting down) and integration components must be installed when this property is invoked.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 7 [desktop apps only] |
| Minimum supported server |
None supported |
| End of client support |
Windows 7 |
| Product |
Windows Virtual PC |
| Header |
|
| IID |
IID_IVMGuestOS is defined as 99fea0db-4880-499a-b6d8-73dff9bc91be |