GetVirtualDiskMetadata function (virtdisk.h)
Retrieves the specified metadata from the virtual disk.
Syntax
DWORD GetVirtualDiskMetadata(
[in] HANDLE VirtualDiskHandle,
[in] const GUID *Item,
[in, out] PULONG MetaDataSize,
[out] PVOID MetaData
);
Parameters
[in] VirtualDiskHandle
Handle to an open virtual disk.
[in] Item
Address of a GUID identifying the metadata to retrieve.
[in, out] MetaDataSize
Address of a ULONG. On input, the value indicates the size, in bytes, of the buffer pointed to by the MetaData parameter. On output, the value contains size, in bytes, of the retrieved metadata. If the buffer was too small, the API will fail and return ERROR_INSUFFICIENT_BUFFER, putting the required size in the ULONG and the buffer will contain the start of the metadata.
[out] MetaData
Address of the buffer where the metadata is to be stored.
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
| Requirement | Value |
|---|---|
| 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 |