◆ getBaudRate()
int oceandirect::api::SerialPortAPI::getBaudRate |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Get the baud rate of the serial port.
- 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 baud rate of the serial port.
◆ saveSettingsToFlash()
void oceandirect::api::SerialPortAPI::saveSettingsToFlash |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
Save settings to flash memory.
- 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. |
◆ setBaudRate()
void oceandirect::api::SerialPortAPI::setBaudRate |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
baudRate |
|
) |
| |
Set the baud rate of the serial port.
- 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. |
baudRate | the desired baud rate of the serial port. |
The documentation for this class was generated from the following file: