IVMDisplay::_GenerateThumbnail method
The _GenerateThumbnail method returns 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.
This method supports standard return values, as well as the following. For information on Virtual Server specific return values not listed below, see HRESULT Codes Specific to the Virtual Server.
| Return code/value | Description |
|---|---|
|
The operation was successful. |
|
The parameter is NULL. |
|
An unexpected error 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 VARIANTs, but is not compatible with scripting clients.
Requirements
| Product |
Microsoft Virtual Server 2005 onWindows Server 2003 |
| Download |
Microsoft Virtual Server 2005 R2 SP1 Update onWindows Server 2008orWindows Server 2003 |
| Header |
|