GetVirtualSystemThumbnailImage method of the Msvm_VirtualSystemManagementService class

Retrieves the thumbnail image, in raw RGB 565 format, of a virtual system or virtual system snapshot.

Syntax

uint32 GetVirtualSystemThumbnailImage(
  [in]  CIM_VirtualSystemSettingData REF TargetSystem,
  [in]  uint16                           WidthPixels,
  [in]  uint16                           HeightPixels,
  [out] uint8                            ImageData[]
);

Parameters

TargetSystem [in]

A reference to the CIM_VirtualSystemSettingData that contains setting data for the virtual system.

WidthPixels [in]

The width of the image.

HeightPixels [in]

The height of the image.

ImageData [out]

An array that contains the image data, in raw RGB 565 format.

Return value

The possible return values are:

Completed with No Error (0)

Method Parameters Checked - Job Started (4096)

Failed (32768)

Access Denied (32769)

Not Supported (32770)

Status is unknown (32771)

Timeout (32772)

Invalid parameter (32773)

System is in use (32774)

Invalid state for this operation (32775)

Incorrect data type (32776)

System is not available (32777)

Out of memory (32778)

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2016
Namespace	Root\HyperVCluster\v2
MOF	WindowsHyperVCluster.V2.mof
DLL	VMMS.exe

See also

Msvm_VirtualSystemManagementService