Is_Saveimageex - THORLABS DCU223x Operation Manual And Sdk

4.5.23 is_SaveImageEx

USB 2.0
USB 3.0
Syntax
INT is_SaveImageEx (HIDS hCam, const IS_CHAR* File, INT fileFormat, INT Param)
Description
Attention
This function is obsolete and should not be used anymore. We recommend to use the
function instead (see also
is_SaveImageEx() saves an image in bitmap (*.BMP), JPEG (*.JPG), or PNG format to a file. The images are
read out from the current image memory. The bitmap is stored with the color depth that was used when allocating
the image memory (in DIB mode) or that was set for the current color mode (in Direct3D mode).
Notes
You can save images with a bit depth of more than 8 bit in the PNG format. 12 bit formats are converted into 16
bit.
In Direct3D mode, overlay data are not saved.
Input parameters
hCam
File
fileFormat
IS_IMG_BMP
IS_IMG_JPG
IS_IMG_PNG
Param
Return values
IS_FILE_WRITE_OPEN_ERROR
IS_INVALID_CAMERA_HANDLE
IS_INVALID_MEMORY_POINTER
IS_INVALID_PARAMETER
IS_NO_SUCCESS
IS_NOT_SUPPORTED
IS_OUT_OF_MEMORY
IS_SEQUENCE_BUF_ALREADY_LOCKED
IS_SUCCESS
© 2013 Thorlabs GmbH
USB 2.0
USB 3.0
Obsolete functions ).
379
Camera handle
Pointer to a string containing the BMP filename You can either pass
an absolute or a relative path.
If NULL is passed, the "Save as" dialog will be displayed.
Specifies the output format of the file.
Bitmap format
JPEG format
PNG format
When you use IS_IMG_JPG or IS_IMG_PNG to specify the file
format, you can set the quality by specifying a value between 1 and
100 for Param. If Param=0, the system uses the default quality
(75).
If you use IS_IMG_BMP, Param does not take effect.
File cannot be opened for writing or reading.
Invalid camera handle
Invalid pointer or invalid memory ID
One of the submitted parameters is outside the valid
range or is not supported for this sensor or is not
available in this mode.
General error message
The camera model used here does not support this
function or setting.
No memory could be allocated.
The memory could not be locked. The pointer to the
buffer is invalid.
Function executed successfully
4 Programming (SDK)
is_ImageFile()
407
264