HvGetPartitionProperty function

The HvGetPartitionProperty function retrieves a property of a partition.

Syntax


HV_STATUS  HvGetPartitionProperty(
  _In_   HV_PARTITION_ID PartitionId,
  _In_   HV_PARTITION_PROPERTY_CODE PropertyCode,
  _Out_  PHV_PARTITION_PROPERTY PropertyValue
);

Parameters

PartitionId [in]: An HV_PARTITION_ID value that identifies the partition to retrieve a property from. HV_PARTITION_ID is defined as an unsigned 64-bit (UINT64) value.
PropertyCode [in]: An HV_PARTITION_PROPERTY_CODE enumeration value that specifies the property for which the caller requires the property value.
PropertyValue [out]: A pointer to an HV_PARTITION_PROPERTY variable in which HvGetPartitionProperty stores the value for the property. HV_PARTITION_PROPERTY is defined as an unsigned 64-bit (UINT64) value.

Return value

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

Return code	Description
HV_STATUS_SUCCESS	HvGetPartitionProperty successfully retrieved a property of a partition.
HV_STATUS_ACCESS_DENIED	The caller is not the parent of the specified target partition (unless the caller and the target partition are both the root partition).
HV_STATUS_INVALID_PARTITION_ID	The specified partition identifier is invalid.
HV_STATUS_UNKNOWN_PROPERTY	The specified property code is not a valid property.
HV_STATUS_INVALID_PARTITION_STATE	The specified partition is not in the active state.

Remarks

The caller must be the specified partition's parent, or the root partition that requests its own properties.

HvGetPartitionProperty has the following restrictions:

The partition that the PartitionId parameter specifies must be in the active state.
The caller must either be the parent of the partition specified by PartitionId or the root partition that specifies its own partition identifier.

Native Interface

HvGetPartitionProperty
	Call Code = 0x0044
Input Parameters
0	PartitionId (8 bytes)
8	PropertyCode (4 bytes) Padding (4 bytes)
Output Parameters
0	PropertyValue (8 bytes)

Requirements