ClassMembersToStrVector
Transfers values from a Class tag to an Array tag.
Function
| Group
| Execution
| Windows
| Embedded
| Thin Client
| Mobile Access
|
ClassMembersToStrVector | String
| Synchronous
| Supported
| Supported
| Supported
| Not supported
|
Syntax
ClassMembersToStrVector( "strClassTag" , numStartPos, numNumPos, "strArrayTag", optBooStartPosTarget )
- strClassTag
- String value containing the Class tag name.
- numStartPos
- Start position (array index) of strClassTag.
- numNumPos
- Number of positions (array indexes) to be transferred from strClassTag.
- strArrayTag
- String value containing the array tag that will receive the values from strClassTag.
- optBooStartPosTarget
- Start position (array index) of strArrayTag. If omitted, the default value 1 is used.
Returned value
−6
| Array size of strClassTag is not big enough for numStartPos
|
−5
| strClassTag is not a Class tag
|
−4
| strClassTag is not found
|
−3
| strArrayTag is not found
|
−2
| Invalid data type of the parameters
|
−1
| Invalid number of parameters
|
0
| Transferred successfully
|
Notes
If strClassTag has more than one member, the value of each member will be transferred to strArrayTag. Therefore, it is importatnt to make sure that the array size of strArrayTag is big enough to receive all values from strClassTag.
Examples
Tag Name
| Expression
|
Tag
| ClassMembersToStrVector( “Classtag”, 5, 3, “Arraytag” ) |
Tag
| ClassMembersToStrVector( “Classtag”, 5, 3, “Arraytag”, 0 ) |
Tag
| ClassMembersToStrVector ( TagName, 0, 1, ArrayName ) |
ClassMembersToStrVector