%HI_CaptureToFile function

Function
The function saves a screenshot of the picture that is called from to a file.


Declaration


BOOL %HI_CaptureToFile(
   TEXT in fileName [, x1,y1, x2, y2, layerLevel]
 )


Parameters


fileNameFile name (including the whole path).
x1,y1, x2, y2 Coordinates that are used in the graphic. They define the selection of picture that will be captured. The resulting size corresponds to the defined coordinates. To capture the selection, all four parameters must be entered. If not or their value is 0, whole picture will be captured. The size will be the same as window size on the screen.
layerLevelIt is applicable for layer pictures. It captures the defined layer. If it is not defined or is 0, the active layer will be captured.


Example


 BOOL _res
 
 _res := %HI_CaptureToFile( "c:\capture.bmp")


Note 1
Saved picture format is defined by filename extension, supported forms are BMP, PNG, JPG a GIF.
Note 2
This function is available also in %HIX_ version.

Active picture manipulation functions
Function arguments - types


You can read a blog about the %HI_CaptureToFile function