EnumerateVirtualDiskMetadata function

Enumerates the metadata associated with a virtual disk.

Syntax

DWORD EnumerateVirtualDiskMetadata(
  HANDLE VirtualDiskHandle,
  PULONG NumberOfItems,
  GUID   *Items
);

Parameters

VirtualDiskHandle

Handle to an open virtual disk.

NumberOfItems

Address of a ULONG. On input, the value indicates the number of elements in the buffer pointed to by the Items parameter. On output, the value contains the number of items retrieved. If the buffer was too small, the API will fail and return ERROR_INSUFFICIENT_BUFFER and the ULONG will contain the required buffer size.

Items

Address of a buffer to be filled with the GUIDs representing the metadata. The GetVirtualDiskMetadata function can be used to retrieve the data represented by each GUID.

Return Value

Status of the request.

If the function succeeds, the return value is ERROR_SUCCESS.

If the buffer pointed to by the Items parameter was too small, the return value is ERROR_INSUFFICIENT_BUFFER.

If the function fails, the return value is an error code. For more information, see System Error Codes.

Requirements

   
Minimum supported client Windows 8
Minimum supported server Windows Server 2012
Target Platform Windows
Header virtdisk.h (include Windows.h)
Library VirtDisk.lib
DLL VirtDisk.dll

See Also

VHD Functions