hwISession CaptureDesktop

Captures the entire desktop to an image file.

Syntax

hwISession_handle CaptureDesktoptype, filename, (quality)

Application

HyperWorks Tcl

Description

This command captures the entire desktop to an image file.

Inputs

type
The file type that you want to save the captured image as. The file type options include: BMP, JPEG, TIFF, PNG or saved to the clipboard.
filename
The file name that you want to call the captured image.
(quality) (Optional)
The level of quality or compression that you want to make the image.

Example

hwi GetSessionHandle sess;
sess CaptureDesktop png MyPicture.png;

Error

Returns success (0) or an error code.

Keywords

HyperWorks

Tcl

Create