#include <LHUserStringAPI.h>
◆ ~LHUserStringAPI()
virtual oceandirect::api::LHUserStringAPI::~LHUserStringAPI |
( |
| ) |
|
|
virtualdefault |
◆ getUserString()
virtual size_t oceandirect::api::LHUserStringAPI::getUserString |
( |
lh_device_id_t | deviceID, |
|
|
lh_error_code_t * | errorCode, |
|
|
char | buffer[], |
|
|
size_t | bufferLength ) |
|
virtual |
.getUserString Get the current stored string on the device.
- See also
- setUserString()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
buffer | the character buffer to receive the resulting string. |
bufferLength | the actual length of the supplied buffer. |
- Returns
- the number of characters copied into the supplied buffer or 0 on error.
◆ setUserString()
virtual void oceandirect::api::LHUserStringAPI::setUserString |
( |
lh_device_id_t | deviceID, |
|
|
lh_error_code_t * | errorCode, |
|
|
const char | buffer[], |
|
|
size_t | bufferLength ) |
|
virtual |
.setUserString Set the stored string on the device.
- See also
- getUserString()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
buffer | the null terminated string containing the desired user string. |
bufferLength | the actual length of the supplied buffer including the null terminating character. |
The documentation for this class was generated from the following file: