|
Map.StringGet
Returns a string representing the location of some controller variable when passed to an enumeration of type Map.
Version History
Introduced in MPX 2.0.
Result
String
Arguments
Overload 1
| |
| Argument |
Type |
Description |
| enumMap |
Mpx.Map |
The enumeration for which the string representation of some controller variable will be returned. |
|
Overload 2
| |
| Argument |
Type |
Description |
| enumMap |
Mpx.Map |
The enumeration for which the string representation of some controller variable will be returned. |
| index |
UInt32 |
Index associated with the enumeration. |
|
Overload 3
| |
| Argument |
Type |
Description |
| enumMap |
Mpx.Map |
The enumeration for which the string representation of some controller variable will be returned. |
| index1 |
UInt32 |
First index associated with the enumeration. |
| index2 |
UInt32 |
Second index associated with the enumeration. |
|
Common Exceptions
| |
| Error |
Occurs when... |
| ObjectNotEnabled |
The Map object is currently not enabled. |
| Parameter |
Specified index or indices are invalid. |
|
Visual Basic
Syntax
Function StringGet(enumMap As Mpx.Map) As String
Function StringGet(enumMap As Mpx.Map, index As UInt32) As String
Function StringGet(enumMap As Mpx.Map, index1 As UInt32, _
index2 As UInt32) As String
Sample Code
| |
Dim strAdd1 As String
Dim strAdd2 As String
Dim strAdd3 As String
'Map.NullInput enumeration does not need additional indices
strAdd1 = _
controller.Map.StringGet(mpx.Map.NullInput)
'Map.ActualPosition enumeration takes 1 additional index of
'the axis number (axis #0 in this example)
strAdd2 = _
controller.Map.StringGet(mpx.Map.ActualPosition, 0)
'Map.SqNodeAnalogIn enumeration takes 2 additional indices of
'node number and analog input number
'(node #0 and analog input #1 in this example)
strAdd3 = _
controller.Map.StringGet(mpx.Map.SqNodeAnalogIn, 0, 1)
|
Sample Application
C#
Syntax
Mpx.DataType StringGet(Mpx.Map enumMap);
Mpx.DataType StringGet(Mpx.Map enumMap, uint index);
Mpx.DataType StringGet(Mpx.Map enumMap, uint index1, uint index2);
Sample Code
| |
string strAdd1;
string strAdd2;
string strAdd3;
//Map.NullInput enumeration does not need additional indices
strAdd1 =
controller.Map.StringGet(Mpx.Map.NullInput);
//Map.ActualPosition enumeration takes 1 additional index of
//the axis number (axis #0 in this example)
strAdd2 =
controller.Map.StringGet(Mpx.Map.ActualPosition, 0);
//Map.SqNodeAnalogIn enumeration takes 2 additional indices of
//node number and analog input number
//(node #0 and analog input #1 in this example)
strAdd3 =
controller.Map.StringGet(Mpx.Map.SqNodeAnalogIn, 0, 1);
|
See Also
DataTypeGet
Enumerations
Map
|
