HvGetNextChildPartition function

The HvGetNextChildPartition function enumerates the child partitions for a given parent partition.

Syntax


HV_STATUS  HvGetNextChildPartition(
  _In_   HV_PARTITION_ID ParentId,
  _In_   HV_PARTITION_ID PreviousChildId,
  _Out_  PHV_PARTITION_ID NextChildId
);

Parameters

ParentId [in]

An HV_PARTITION_ID value that identifies the parent partition for which to enumerate the child partitions. HV_PARTITION_ID is defined as an unsigned 64-bit (UINT64) value.

PreviousChildId [in]

An HV_PARTITION_ID value that identifies the previous child partition to be enumerated or HV_PARTITION_ID_INVALID to specify that the first child partition should be returned.

NextChildId [out]

A pointer to an HV_PARTITION_ID variable in which HvGetNextChildPartition stores the identifier of the next child partition in the list or the HV_PARTITION_ID_INVALID partition identifier if the previous partition was the final child partition.

Return value

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

Return codeDescription
HV_STATUS_SUCCESS

HvGetNextChildPartition successfully retrieved the next child partition for the specified parent partition.

HV_STATUS_ACCESS_DENIED

The caller is not the parent of the specified partition.

HV_STATUS_INVALID_PARTITION_ID

The specified parent partition identifier is invalid.

The specified PreviousChildId is not the value HV_PARTITION_ID_INVALID and is not a valid child partition of the partition that is identified by ParentId.

 

Remarks

To begin the enumeration process, the caller should specify HV_PARTITION_ID_INVALID in PreviousChildId. Subsequent calls should specify the identifier of the previously-returned child identifier. When the caller has enumerated all partition identifiers, the value HV_PARTITION_ID_INVALID will be returned in NextChildId.

If a child partition is created or deleted during enumeration, the results are dependent on whether the caller has already enumerated past the deleted or inserted partition. Callers should be prepared to handle an HV_STATUS_INVALID_PARTITION_ID error condition that might indicate that the partition that is identified by PreviousChildId has been deleted.

Partitions are not guaranteed to be returned by the hypervisor enumerated in any specific order.

HvGetNextChildPartition has the following restriction:

  • The partition that is specified by ParentId must be the parent of the partition that is specified by PreviousChildId.

Native Interface

HvGetNextChildPartition

Call Code = 0x0047

Input Parameters

0

ParentId (8 bytes)

8

PreviousChildId (8 bytes)

Output Parameters

0

NextChildId (8 bytes)

 

Requirements

Version

HvGetNextChildPartition 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.