Edit

IVMDisplay::Thumbnail property

  • Article

[Windows Virtual PC is no longer available for use as of Windows 8. Instead, use the Hyper-V WMI provider (V2).]

Retrieves an array of pixels representing a thumbnail image of the virtual machine's screen.

This property is read-only.

Syntax

HRESULT get_Thumbnail(
  [out, retval] VARIANT *thumbnailImage
);

Property value

A variant of type VT_ARRAY | VT_VARIANT containing entries of type VT_UI4, one for each pixel in the thumbnail.

Error codes

Name/value Meaning
S_OK
0
 The operation was successful.
E_POINTER
0x80004003
 The parameter is NULL.
DISP_E_EXCEPTION
0x80020009
 An unexpected error has occurred.

Remarks

This interface returns the thumbnail less efficiently than the _GenerateThumbnail method, but is usable from scripting clients. The thumbnail is always 64 pixels wide by 48 pixels high. Each pixel is 32 bits. The first 64 elements in the array is the first row of pixels in the thumbnail, the next 64 elements is the second row, and so on.

Requirements

Requirement Value
Minimum supported client
 Windows 7 [desktop apps only]
Minimum supported server
 None supported
End of client support
 Windows 7
Product
 Windows Virtual PC
Header
VPCCOMInterfaces.h
IID
 IID_IVMDisplay is defined as 960895e9-f743-4498-96aa-261f867e7fc5

See also

IVMDisplay