|
|
GigE |
GigE |
Syntax
INT is_BootBoost (HIDS hCam, UINT nCommand, void* pParam, UINT cbSizeOfParam)
Description
The function is_BootBoost() opens the camera at the system start and allows a faster access to the camera in the running application (see boot boost).
|
|
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. |
||||||||||||||||||
Contents of the IS_BOOTBOOST_ID structure
IS_BOOTBOOST_ID_MIN |
Smallest valid ID (1) |
IS_BOOTBOOST_ID_MAX |
Biggest valid ID (254) |
IS_BOOTBOOST_ID_NONE |
Special value for no ID (0) |
IS_BOOTBOOST_ID_ALL |
Special value for all IDs (255) |
Contents of the IS_BOOTBOOST_IDLIST structure
DWORD |
u32NumberOfEntries |
Number of listed objects |
IS_BOOTBOOST |
aList |
List information |
Return values
IS_INVALID_PARAMETER |
One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode. |
IS_IO_REQUEST_FAILED |
An IO request from the uEye driver failed. Possibly the versions of the ueye_api.dll (API) and the driver file (ueye_usb.sys or ueye_eth.sys) do not match. |
IS_NO_SUCCESS |
General error message |
IS_NOT_SUPPORTED |
The camera model used here does not support this function or setting. |
IS_SUCCESS |
Function executed successfully |
INT nRet = IS_SUCCESS;
// Enable Boot-Boost mode
nRet = is_BootBoost(NULL, IS_BOOTBOOST_CMD_ENABLE, NULL, 0);
// Disable Boot-Boost mode
nRet = is_BootBoost(NULL, IS_BOOTBOOST_CMD_DISABLE, NULL, 0);
UINT u32Enable = 0;
nRet = is_BootBoost(NULL, IS_BOOTBOOST_CMD_GET_ENABLED, (void*)&u32Enable, sizeof(u32Enable));
if (nRet == IS_SUCCESS)
{
if (u32Enable != 0)
{
// Boot-Boost is enabled
}
}
INT nRet = IS_SUCCESS;
IS_BOOTBOOST_ID nBootboostValue = 0;
// Add camera ID 5
nBootboostValue = 5;
nRet = is_BootBoost(NULL, IS_BOOTBOOST_CMD_ADD_ID, (void*)&nBootboostValue, sizeof(nBootboostValue));
// Remove camera ID 5
nBootboostValue = 5;
nRet = is_BootBoost(NULL, IS_BOOTBOOST_CMD_REMOVE_ID, (void*)&nBootboostValue, sizeof(nBootboostValue));
// Set all camera IDs (1 - 254)
nBootboostValue = IS_BOOTBOOST_ID_ALL;
nRet = is_BootBoost(NULL, IS_BOOTBOOST_CMD_ADD_ID, (void*)&nBootboostValue, sizeof(nBootboostValue));
INT nRet = IS_SUCCESS;
// The list has 3 entries
UINT nNumber = 3;
// Calculate the correct size in bytes of the Boot-Boost list
UINT nSize = sizeof(IS_BOOTBOOST_IDLIST) + ((nNumber - 1) * sizeof(IS_BOOTBOOST_ID));
// This line is equivalent
nSize = IS_BOOTBOOST_IDLIST_HEADERSIZE + (nNumber * IS_BOOTBOOST_IDLIST_ELEMENTSIZE);
IS_BOOTBOOST_IDLIST *pBootBoostList = (IS_BOOTBOOST_IDLIST*)new BYTE[nSize];
// Add the IDs 1, 2 and 3
pBootBoostList->aList[0] = 1;
pBootBoostList->aList[1] = 2;
pBootBoostList->aList[2] = 3;
// Set the list
INT nRet = is_BootBoost(NULL, IS_BOOTBOOST_CMD_SET_IDLIST, (void*)pBootBoostList, nSize);
delete [] pBootBoostList;
pBootBoostList = NULL;
// Clear the list
nRet = is_BootBoost(NULL, IS_BOOTBOOST_CMD_CLEAR_IDLIST, NULL, 0);
INT nRet = IS_SUCCESS;
// Get the size of the Boot-Boost list
UINT nNumber = 0;
nRet = is_BootBoost(NULL, IS_BOOTBOOST_CMD_GET_IDLIST_SIZE, (void*)&nNumber, sizeof(nNumber));
if ((nNumber > 0) && (nRet == IS_SUCCESS))
{
// Calculate the correct size in bytes of the Boot-Boost list
UINT nSize = sizeof(IS_BOOTBOOST_IDLIST) + ((nNumber - 1) * sizeof(IS_BOOTBOOST_ID));
// This line is equivalent
nSize = IS_BOOTBOOST_IDLIST_HEADERSIZE + (nNumber * IS_BOOTBOOST_IDLIST_ELEMENTSIZE);
IS_BOOTBOOST_IDLIST *pBootBoostList = (IS_BOOTBOOST_IDLIST*)new BYTE[nSize];
// Get the list
nRet = is_BootBoost(NULL, IS_BOOTBOOST_CMD_GET_IDLIST, (void*)m_pBootBoostList, nSize);
Suggestion for improvement? Send us your short Feedback on this chapter.
Thank you very much!
For technical questions please contact you local distributor or use the support form on our website.