Canvas_BitmapSaveImageFile

<< Click to Display Table of Contents >>

Navigation:  ThinBASIC Modules > UI (User Interface) > CONTROLS > Control Types > Canvas Control > Canvas Control Commands >

Canvas_BitmapSaveImageFile

 

Description

 

Save a canvas target as an image file.

Supported image file can be one of the following extension: .png .jpg .jpeg .gif .bmp .tif

 

Syntax

 

n = Canvas_BitmapSaveImageFile(ImageFileWithExtension [, hWnd[, CtrlID]])

 

Returns

 

Number.

Zero = no errors

 

Parameters

 

 

Name

Type

Optional

Meaning

ImageFileWithExtension

String

No

Full path of the image file to save.

If file already exists it will be replaced.

 

Image type will be derived by file name extension. Supported image file can be one of the following extension: .png .jpg .jpeg .gif .bmp .tif

hWnd

Number

Yes

Handle of the Canvas Window, Window, or Bitmap to be used by subsequent Canvas statements.

CtrlID

Number

Yes

The control id, if the target is a Canvas Control, or zero if the target is a Canvas Window or Bitmap

 

Remarks

 

Restrictions

 

Image type will be automatically derived by file name extension.

Supported image file can be one of the following extension: .png .jpg .jpeg .gif .bmp .tif

 

See also

 

Examples