NetOceanDirect  3.1.1
OceanDirect .NET API
Public Member Functions | Static Public Member Functions | Static Protected Attributes | List of all members
NetOceanDirect::DeviceAlias Class Reference

Inherits NetOceanDirect::ManagedObject< DeviceAliasAPI >.

Public Member Functions

 DeviceAlias (DeviceAliasAPI *instance)
 
String getDeviceAlias (long deviceID, int %errorCode)
 
void setDeviceAlias (long deviceID, int %errorCode, String ^deviceAlias)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< DeviceAliasAPI >
 ManagedObject (DeviceAliasAPI *instance)
 
DeviceAliasAPI * GetInstance ()
 

Static Public Member Functions

static DeviceAlias getInstance ()
 

Static Protected Attributes

static DeviceAlias deviceAlias
 

Additional Inherited Members

- Protected Attributes inherited from NetOceanDirect::ManagedObject< DeviceAliasAPI >
DeviceAliasAPI * m_Instance
 

Member Function Documentation

◆ 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
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
Returns
the device alias.

◆ setDeviceAlias()

void DeviceAlias::setDeviceAlias ( long  deviceID,
int %  errorCode,
String ^  deviceAlias 
)

Set the device alias.

See also
getDeviceAlias()
Parameters
[in]deviceIDthe device ID for the device to be configured (from OceanDirect::findDevices())
[out]errorCodeset to 0 if successful, an OceanDirect error code (nonzero) otherwise
[in]deviceAliasthe device alias.

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