HvGetPortProperty function

The HvGetPortProperty function allows an authorized guest to read a property of a port.

Syntax


HV_STATUS  HvGetPortProperty(
  _In_   HV_PARTITION_ID PartitionId,
  _In_   HV_PORT_ID PortId,
  _In_   HV_PORT_PROPERTY_CODE PropertyCode,
  _Out_  PHV_PORT_PROPERTY PropertyValue
);

Parameters

PartitionId [in]: An HV_PARTITION_ID value that identifies the partition that owns the port that the PortId parameter identifies. HV_PARTITION_ID is defined as an unsigned 64-bit (UINT64) value.
PortId [in]: An HV_PORT_ID value that identifies a previously-created port within the partition that PartitionId specifies.
PropertyCode [in]: An HV_PORT_PROPERTY_CODE value that specifies the property for which HvGetPortProperty retrieves the property value.
PropertyValue [out]: A pointer to an HV_PORT_PROPERTY variable in which HvGetPortProperty stores the retrieved value for the property that the PropertyCode parameter specifies. HV_PORT_PROPERTY is defined as an unsigned 64-bit (UINT64) value.

Return value

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

Return code	Description
HV_STATUS_SUCCESS	HvGetPortProperty successfully read a property of a port.
HV_STATUS_ACCESS_DENIED	Neither of the following is true: The caller is the parent of the specified target partition or the partition itself. The caller has the CreatePort partition property.
HV_STATUS_INVALID_PARTITION_ID	The specified partition identifier is invalid.
HV_STATUS_INVALID_PORT_ID	The specified port identifier is invalid.
HV_STATUS_UNKNOWN_PROPERTY	The property code that the PropertyCode parameter specifies is not a recognized property.

Remarks

The caller must possess the CreatePort privilege.
The partition that is specified by PartitionId must be in the active state.
The caller must be the parent of the partition that is specified by PartitionId, or the caller must specify its own partition identifier.

Native Interface

HvGetPortProperty
	Call Code = 0x005A
Input Parameters
0	PartitionId (8 bytes)
8	PortId (8 bytes)
16	PropertyCode (4 bytes) Padding (4 bytes)
Output Parameters
0	PropertyValue (8 bytes)

Requirements