OceanDirect  2.4.0
OceanDirect C++/C API
oceandirect::api::DeviceAliasAPI Class Reference

Public Member Functions

int getDeviceAlias (long deviceID, int *errorCode, char *buffer, int bufferLength)
 
void setDeviceAlias (long deviceID, int *errorCode, char *buffer, int bufferLength)
 

Static Public Member Functions

static DeviceAliasAPIgetInstance ()
 
static void shutdown ()
 

Member Function Documentation

◆ getDeviceAlias()

int oceandirect::api::DeviceAliasAPI::getDeviceAlias ( long  deviceID,
int *  errorCode,
char *  buffer,
int  bufferLength 
)

Get the device alias of the device.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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.
bufferthe buffer to receive the device alias.
bufferLengththe length of the buffer.
Returns
the number of bytes read.

◆ setDeviceAlias()

void oceandirect::api::DeviceAliasAPI::setDeviceAlias ( long  deviceID,
int *  errorCode,
char *  buffer,
int  bufferLength 
)

Set the device alias of the device.

Parameters
deviceIDthe ID of the device returned by getDeviceIDs.
errorCodea 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.
bufferthe buffer containing the desired device alias.
bufferLengththe length of the buffer.

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