#include <BackToBackAPI.h>
◆ BackToBackAPI()
oceandirect::api::BackToBackAPI::BackToBackAPI |
( |
| ) |
|
◆ ~BackToBackAPI()
virtual oceandirect::api::BackToBackAPI::~BackToBackAPI |
( |
| ) |
|
|
virtual |
◆ getInstance()
static BackToBackAPI * oceandirect::api::BackToBackAPI::getInstance |
( |
| ) |
|
|
static |
◆ getNumberOfBackToBackScans()
virtual unsigned long oceandirect::api::BackToBackAPI::getNumberOfBackToBackScans |
( |
long | deviceID, |
|
|
int * | errorCode ) |
|
virtual |
Get the current number of back to back scans.
- See also
- setNumberOfBackToBackScans()
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
- Returns
- the current number of back to back scans.
◆ setNumberOfBackToBackScans()
virtual void oceandirect::api::BackToBackAPI::setNumberOfBackToBackScans |
( |
long | deviceID, |
|
|
int * | errorCode, |
|
|
unsigned long | numScans ) |
|
virtual |
Set the current number of back to back scans.
- See also
- getNumberOfBackToBackScans()
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
numScans | the desired number of back to back scans. |
◆ shutdown()
static void oceandirect::api::BackToBackAPI::shutdown |
( |
| ) |
|
|
static |
◆ instance
The documentation for this class was generated from the following file: