IDS Software Suite 4.96.1
 |
 |
|---|---|
USB 2.0 USB 3.x GigE |
USB 2.0 USB 3.x GigE |
Syntax
INT is_ParameterSet(HIDS hCam, UINT nCommand, void* pParam, UINT cbSizeOfParam)
Description
The is_ParameterSet() function saves the current camera parameters to a file or to the user memory of the camera and loads the parameter set from a file or the user memory.
Note that the following settings are only saved in the parameter file and not in the user memory of the camera:
•Long exposure settings
•Color mode settings
Only camera-specific ini files can be loaded. The uEye parameter file section in the appendix describes the structure of a uEye ini file.
|
Due to the changed behavior of the USB 3 uEye CP Rev. 2 from driver version 4.80 on, the internal image memory can only be enabled or disabled if the camera is closed. Therefore, parameter files created with a previous driver version, needs to be reviewed. |
|
When loading an ini file, make sure that the image size (AOI) and color depth parameters in the ini file match those in the allocated memory. Otherwise, display errors may occur. |
The nCommand input parameter is used to select the function mode. The pParam input parameter depends on the selected function mode. If you select functions for setting or returning a value, pParam contains a pointer to a variable of the UINT type. The size of the memory area to which pParam refers is specified in the cbSizeOfParam input parameter.
Input parameter
hCam |
Camera handle |
pParam |
Pointer to a function parameter, whose function depends on nCommand. |
cbSizeOfParam |
Size (in bytes) of the memory area to which pParam refers. |
Return values
IS_INCOMPATIBLE_SETTING |
Because of other incompatible settings the function is not possible. |
IS_INVALID_CAMERA_TYPE |
The camera type defined in the .ini file does not match the current camera model. |
IS_NO_SUCCESS |
General error message |
IS_SUCCESS |
Function executed successfully |
Related functions
INT nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_LOAD_EEPROM, NULL, NULL);
// Load parameters from file (open filebox)
INT nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_LOAD_FILE, NULL, NULL);
// Load parameters from specified file using an absolute path
nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_LOAD_FILE, L"D:\\Camera\\Settings\\file.ini", NULL);
// Load parameters from specified file using a relative path
nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_LOAD_FILE, L"file.ini", NULL);
INT nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_SAVE_EEPROM, NULL, NULL);
// Save parameters to file (open filebox)
INT nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_SAVE_FILE, NULL, NULL);
// Save parameters to specified file
nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_SAVE_FILE, L"file.ini", NULL);
// Get the number of supported parameter sets in the camera's user memory
UINT nNumber;
INT nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_GET_NUMBER_SUPPORTED, (void*)
&nNumber, sizeof(nNumber));
// Check if parameter set in the user memory is supported by the camera
UINT nSupportedHWParameterSet;
INT nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_GET_HW_PARAMETERSET_AVAILABLE,
(void*)&nSupportedHWParameterSet, sizeof(nSupportedHWParameterSet));
if (nRet == IS_SUCCESS)
{
if (nSupportedHWParameterSet == 1)
{
// supported
}
}
// Delete parameter set in user memory
INT nRet = is_ParameterSet(m_hCam, IS_PARAMETERSET_CMD_ERASE_HW_PARAMETERSET, NULL, NULL);
