NetOceanDirect 3.1.3
OceanDirect .NET API
NetOceanDirect::UserString Class Reference

#include <UserString.h>

Inherits NetOceanDirect::ManagedObject< UserStringAPI >.

Public Member Functions

 UserString (UserStringAPI *instance)
 
virtual ~UserString ()
 
String getUserString (long deviceID, int %errorCode)
 
String getUserString (long deviceID, int %errorCode, int index)
 
int getUserStringCount (long deviceID, int %errorCode)
 
void setUserString (long deviceID, int %errorCode, int index, String ^userStr)
 
void setUserString (long deviceID, int %errorCode, String ^userStr)
 
- Public Member Functions inherited from NetOceanDirect::ManagedObject< UserStringAPI >
 ManagedObject (UserStringAPI *instance)
 
 !ManagedObject ()
 
virtual ~ManagedObject ()
 
UserStringAPI * GetInstance ()
 

Static Public Member Functions

static UserString getInstance ()
 

Protected Member Functions

 UserString ()
 

Static Protected Attributes

static UserString userString
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ UserString() [1/2]

UserString::UserString ( )
protected

◆ UserString() [2/2]

UserString::UserString ( UserStringAPI * instance)

◆ ~UserString()

virtual NetOceanDirect::UserString::~UserString ( )
inlinevirtual

Member Function Documentation

◆ getInstance()

UserString UserString::getInstance ( )
static

◆ getUserString() [1/2]

String UserString::getUserString ( long deviceID,
int % errorCode )

Read the user string. If this field in the device is not yet populated then a non-zero(6) code will be returned.

See also
setUserString()
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 user string.

◆ getUserString() [2/2]

String UserString::getUserString ( long deviceID,
int % errorCode,
int index )

Read the user string from the given index. If the device don't support this command then a non-zero error code will be returned.

See also
setUserString()
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 user string.

◆ getUserStringCount()

int UserString::getUserStringCount ( long deviceID,
int % errorCode )

Read the total user strings stored in the device. If the device don't support this command then a non-zero error code will be returned.

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 user string count.

◆ setUserString() [1/2]

void UserString::setUserString ( long deviceID,
int % errorCode,
int index,
String ^ userStr )

Set the user string at the given index. If the device don't support this command then a non-zero error code will be returned.

See also
getUserString()
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

◆ setUserString() [2/2]

void UserString::setUserString ( long deviceID,
int % errorCode,
String ^ userStr )

Set the user string.

See also
getUserString()
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

Member Data Documentation

◆ userString

UserString NetOceanDirect::UserString::userString
staticprotected

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