HvFinalizePartition function

The HvFinalizePartition function begins the partition destruction operation by freeing all internal hypervisor resources.

Syntax


HV_STATUS  HvFinalizePartition(
  _In_  HV_PARTITION_ID PartitionId
);

Parameters

PartitionId [in]

An HV_PARTITION_ID value that identifies the partition to finalize. HV_PARTITION_ID is defined as an unsigned 64-bit (UINT64) value.

Return value

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

Return codeDescription
HV_STATUS_SUCCESS

HvFinalizePartition successfully finalized the partition.

HV_STATUS_ACCESS_DENIED

The specified partition is not a child of the caller.

HV_STATUS_INVALID_PARTITION_ID

The specified partition identifier is invalid.

HV_STATUS_OPERATION_DENIED

The specified partition has one or more children.

HV_STATUS_INVALID_PARTITION_STATE

The specified partition is not in the active state.

 

Remarks

The HvFinalizePartition call begins the irreversible destruction process of a partition and its children. It frees internal hypervisor data structures, returning the memory to the partition's memory pool so the pages can be subsequently withdrawn.

Finalization processing for a partition and its descendents takes an indeterminate amount of time. The architectural state of the partition(s) involved will be in transition until the process completes.

The caller must be the parent of the specified partition. In addition, the partition must be in either the active or finalizing state. For more information about partition destruction, see Partition Destruction.

HvFinalizePartition has the following restrictions:

  • The specified partition must be in the active or finalizing state.

  • The caller must be the parent of the specified partition.

Native Interface

HvFinalizePartition [fast]

Call Code = 0x0042

Input Parameters

0

PartitionId (8 bytes)

 

Requirements

Version

HvFinalizePartition 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

Show:
© 2014 Microsoft. All rights reserved.