#include <DeviceAliasAPI.h>
◆ DeviceAliasAPI()
oceandirect::api::DeviceAliasAPI::DeviceAliasAPI |
( |
| ) |
|
◆ ~DeviceAliasAPI()
virtual oceandirect::api::DeviceAliasAPI::~DeviceAliasAPI |
( |
| ) |
|
|
virtual |
◆ getDeviceAlias()
virtual int oceandirect::api::DeviceAliasAPI::getDeviceAlias |
( |
long | deviceID, |
|
|
int * | errorCode, |
|
|
char * | buffer, |
|
|
int | bufferLength ) |
|
virtual |
Get the device alias of the device.
- See also
- setDeviceAlias()
- 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. |
buffer | the buffer to receive the device alias. |
bufferLength | the length of the buffer. |
- Returns
- the number of bytes read.
◆ getInstance()
static DeviceAliasAPI * oceandirect::api::DeviceAliasAPI::getInstance |
( |
| ) |
|
|
static |
◆ setDeviceAlias()
virtual void oceandirect::api::DeviceAliasAPI::setDeviceAlias |
( |
long | deviceID, |
|
|
int * | errorCode, |
|
|
char * | buffer, |
|
|
int | bufferLength ) |
|
virtual |
Set the device alias of the device.
- See also
- getDeviceAlias()
- 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. |
buffer | the buffer containing the desired device alias. |
bufferLength | the length of the buffer. |
◆ shutdown()
static void oceandirect::api::DeviceAliasAPI::shutdown |
( |
| ) |
|
|
static |
◆ instance
The documentation for this class was generated from the following file: