Inherits NetOceanDirect::ManagedObject< UserStringAPI >.
|
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) |
|
| ManagedObject (UserStringAPI *instance) |
|
UserStringAPI * | GetInstance () |
|
|
UserStringAPI * | m_Instance |
|
◆ 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.
- Parameters
-
- 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.
- Parameters
-
- 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
-
- 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.
- Parameters
-
◆ setUserString() [2/2]
void UserString::setUserString |
( |
long |
deviceID, |
|
|
int % |
errorCode, |
|
|
String ^ |
userStr |
|
) |
| |
Set the user string.
- Parameters
-
The documentation for this class was generated from the following files: