© 2013 Thorlabs GmbH406
DCx Cameras
4.5.22 is_SaveImage
Syntax
INT is_SaveImage (HIDS hCam, const IS_CHAR* File)
Description
Attention
This function is obsolete and should not be used anymore. We recommend to use the is_ImageFile()
function instead (see also Obsolete functions ).
is_SaveImage() saves an image in bitmap (*.BMP) 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).
Note
In Direct3D mode, overlay data are not saved.
Input parameters
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.
Return values
File cannot be opened for writing or reading.
IS_INVALID_MEMORY_POINTER
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.
The camera model used here does not support this
function or setting.
No memory could be allocated.
IS_SEQUENCE_BUF_ALREADY_LOCKED
The memory could not be locked. The pointer to the
buffer is invalid.
Function executed successfully
Related functions
is_ImageFile()
is_GetImageMem()
is_SetImageMem()
264
379
264
247
337