HvDeleteVp function

The HvDeleteVp function deletes an existing virtual processor (VP) and its related data structures from a partition.

Syntax

C++


HV_STATUS  HvDeleteVp(
  _In_  HV_PARTITION_ID PartitionId,
  _In_  HV_VP_INDEX VpIndex
);

Parameters

PartitionId [in]: An HV_PARTITION_ID value that identifies the partition that HvDeleteVp deletes an existing virtual processor from. HV_PARTITION_ID is defined as an unsigned 64-bit (UINT64) value.
VpIndex [in]: An HV_VP_INDEX value that specifies the index of the virtual processor that HvDeleteVp deletes. HV_VP_INDEX is defined as an unsigned 32-bit (UINT32) value.

Return value

HvDeleteVp returns one of the following values. In addition to these values, HvDeleteVp can also return one of the values that are specified in Common Hypercall Status Codes.

Return code	Description
HV_STATUS_SUCCESS	HvDeleteVp successfully deleted an existing virtual processor from the specified partition.
HV_STATUS_ACCESS_DENIED	The caller is not the parent of the specified partition.
HV_STATUS_INVALID_PARTITION_ID	The specified partition identifier is invalid.
HV_STATUS_INVALID_VP_INDEX	The specified VP index does not reference a virtual processor within the specified partition.
HV_STATUS_INVALID_PARTITION_STATE	The specified partition is not in the active state.

Remarks

HvDeleteVp returns the memory that was consumed by the virtual processor's internal data structures back to the memory pool of the virtual processor's partition.

HvDeleteVp has the following restrictions:

The partition that PartitionId specifies must be in the active state.
The caller must be the parent of the partition that is specified by PartitionId.

Native Interface

HvDeleteVp [fast]
	Call Code = 0x004F
Input Parameters
0	PartitionId (8 bytes)
8	VpIndex (4 bytes) Padding (4 bytes)

Requirements

Version	HvDeleteVp is available in version 1.0 and later versions of the hypervisor.
Header	Hvgdk.h (include Hvgdk.h)
IRQL	Any level

Send comments about this topic to Microsoft

Build date: 11/16/2013