Is_Saveimage - THORLABS DCU223x Operation Manual And Sdk

DCx Cameras

4.5.22 is_SaveImage

USB 2.0
USB 3.0
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
function instead (see also
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
hCam
File
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
Related functions
is_ImageFile()
264
is_GetImageMem()
is_SetImageMem()
406
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.
247
337
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
is_ImageFile()
© 2013 Thorlabs GmbH
264