OceanDirectLighthouse 3.1.3
OceanDirect Lighthouse C++/C API
oceandirect::api::LHUserStringAPI Class Reference

#include <LHUserStringAPI.h>

Public Member Functions

virtual ~LHUserStringAPI ()=default
 
virtual size_t getUserString (lh_device_id_t deviceID, lh_error_code_t *errorCode, char buffer[], size_t bufferLength)
 
virtual void setUserString (lh_device_id_t deviceID, lh_error_code_t *errorCode, const char buffer[], size_t bufferLength)
 

Constructor & Destructor Documentation

◆ ~LHUserStringAPI()

virtual oceandirect::api::LHUserStringAPI::~LHUserStringAPI ( )
virtualdefault

Member Function Documentation

◆ 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
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
bufferthe character buffer to receive the resulting string.
bufferLengththe 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
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
bufferthe null terminated string containing the desired user string.
bufferLengththe actual length of the supplied buffer including the null terminating character.

The documentation for this class was generated from the following file: