Inherits NetOceanDirect::ManagedObject< DeviceAliasAPI >.
|
| DeviceAlias (DeviceAliasAPI *instance) |
|
String | getDeviceAlias (long deviceID, int %errorCode) |
|
void | setDeviceAlias (long deviceID, int %errorCode, String ^deviceAlias) |
|
| ManagedObject (DeviceAliasAPI *instance) |
|
DeviceAliasAPI * | GetInstance () |
|
|
DeviceAliasAPI * | m_Instance |
|
◆ getDeviceAlias()
String DeviceAlias::getDeviceAlias |
( |
long |
deviceID, |
|
|
int % |
errorCode |
|
) |
| |
Read the device alias. If this field in the device is not yet populated then a non-zero(6) code will be returned.
- See also
- setDeviceAlias()
- Parameters
-
- Returns
- the device alias.
◆ setDeviceAlias()
void DeviceAlias::setDeviceAlias |
( |
long |
deviceID, |
|
|
int % |
errorCode, |
|
|
String ^ |
deviceAlias |
|
) |
| |
Set the device alias.
- See also
- getDeviceAlias()
- Parameters
-
[in] | deviceID | the device ID for the device to be configured (from OceanDirect::findDevices()) |
[out] | errorCode | set to 0 if successful, an OceanDirect error code (nonzero) otherwise |
[in] | deviceAlias | the device alias. |
The documentation for this class was generated from the following files: