IVMDisplay::_GenerateThumbnail method

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

Syntax

HRESULT _GenerateThumbnail(
  [out] unsigned long thumbnailImage[3072]
);

Parameters

thumbnailImage [out]

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

Return value

This method can return one of these values.

Return code/value	Description
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 more efficiently than the Thumbnail property, but is not usable from scripting clients. The thumbnail is always 64 pixels wide by 48 pixels high. Each pixel is 32 bits, where the upper 8 bits represent the blue value of the pixel, the next 8 bits represent the green value of the pixel, and the next 8 bits represent the red value of the pixel. The first 64 elements in the array is the first row of the thumbnail, the next 64 elements is the second row, and so on. This method returns a static array of pixels, which is more efficient than returning a SAFEARRAY of VARIANT values, but is not compatible with scripting clients.

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