Instructions - String
1. String Append (STRING_SPELL)
Description: Appends desired characters to an existing string variable or a new character variable, forming a new string variable.
Instruction Name: STRING_SPELL
type Value: 223
Parameter List
| Parameter | Type | Description | Example Value |
|---|---|---|---|
| logout | bool | Whether commented out. true: this instruction will not be executed in the job file; false: not commented, executable | false |
| type | int | Instruction type, string append is 223 in the enumeration sequence | 223 |
| userParamInt | int | Customer custom in secondary development, currently no meaning | 0 |
| userParamString | string | Customer custom in secondary development, currently no meaning | "" |
| variable | object | Variable type and name; string type variable, global or local | {"data":0.0,"secondvalue":0,"value":8,"varname":"S001"} |
| variableValue | object | Appended character variable; string type variable, global or local | {"data":0.0,"secondvalue":0,"value":8,"varname":"GS001"} |
JSON Example
json
{
"logout": false,
"type": 223,
"userParamInt": 0,
"userParamString": "",
"variable": {"data": 0.0, "secondvalue": 0, "value": 8, "varname": "S001"},
"variableValue": {"data": 0.0, "secondvalue": 0, "value": 8, "varname": "GS001"}
}2. Index Slice (STRING_SLICE)
Description: Extracts a portion of a string variable and stores the extracted substring into a specified variable.
Instruction Name: STRING_SLICE
type Value: 224
Parameter List
| Parameter | Type | Description | Example Value |
|---|---|---|---|
| logout | bool | Whether commented out. true: this instruction will not be executed in the job file; false: not commented, executable | false |
| type | int | Instruction type, index slice is 224 in the enumeration sequence | 224 |
| userParamInt | int | Customer custom in secondary development, currently no meaning | 0 |
| userParamString | string | Customer custom in secondary development, currently no meaning | "" |
| startIndex | object | Start index position; int type manual value or variable, global or local | {"data":2.0,"secondvalue":0,"value":0,"varname":""} |
| endIndex | object | End index position; int type manual value or variable, global or local | {"data":8.0,"secondvalue":0,"value":0,"varname":""} |
| dataVariable | object | Storage location for queried data; string type variable, global or local | {"data":0.0,"secondvalue":1,"value":8,"varname":"GS[I001]"} |
| variable | object | The string variable to be sliced; string type variable, global or local | {"data":0.0,"secondvalue":0,"value":8,"varname":"S001"} |
JSON Example
json
{
"logout": false,
"type": 224,
"userParamInt": 0,
"userParamString": "",
"startIndex": {"data": 2.0, "secondvalue": 0, "value": 0, "varname": ""},
"endIndex": {"data": 8.0, "secondvalue": 0, "value": 0, "varname": ""},
"dataVariable": {"data": 0.0, "secondvalue": 1, "value": 8, "varname": "GS[I001]"},
"variable": {"data": 0.0, "secondvalue": 0, "value": 8, "varname": "S001"}
}3. String Delimiter Split (STRING_SPLIT)
Description: Splits a character from a string variable and stores the split characters sequentially into specified variables.
Instruction Name: STRING_SPLIT
type Value: 225
Parameter List
| Parameter | Type | Description | Example Value |
|---|---|---|---|
| logout | bool | Whether commented out. true: this instruction will not be executed in the job file; false: not commented, executable | false |
| type | int | Instruction type, string delimiter split is 225 in the enumeration sequence | 225 |
| userParamInt | int | Customer custom in secondary development, currently no meaning | 0 |
| userParamString | string | Customer custom in secondary development, currently no meaning | "" |
| separator | object | Delimiter; string type manual value or variable, global or local | {"data":0.0,"secondvalue":0,"value":8,"varname":"GS001"} |
| variable | object | The string variable name to be extracted; string type variable, global or local | {"data":0.0,"secondvalue":1,"value":8,"varname":"S[I001]"} |
| dataVariable | object | First storage position for queried data; string type variable, global or local | {"data":0.0,"secondvalue":0,"value":8,"varname":"S001"} |
| dataStorage | object | Records the count of extracted data; string type manual "0" or int type variable, global or local. String type manual "0" means not used | {"data":0.0,"secondvalue":1,"value":8,"varname":"GI[I001]"} |
JSON Example
json
{
"dataStorage": {"data": 0.0, "secondvalue": 1, "value": 8, "varname": "GI[I001]"},
"dataVariable": {"data": 0.0, "secondvalue": 0, "value": 8, "varname": "S001"},
"logout": false,
"separator": {"data": 0.0, "secondvalue": 0, "value": 8, "varname": "GS001"},
"type": 225,
"userParamInt": 0,
"userParamString": "",
"variable": {"data": 0.0, "secondvalue": 1, "value": 8, "varname": "S[I001]"}
}4. String Locate (STRING_LOCATE)
Description: Queries the position of a character in a string variable and stores the position and count into specified variables.
Note:
- If the character to be indexed is non-contiguous in a string, the position and count of the character cannot be read when executing the locate query instruction
- If the character to be indexed is contiguous in a string, the character position read when executing the locate query instruction is the position of the first indexed variable, and the data count is 1
Instruction Name: STRING_LOCATE
type Value: 226
Parameter List
| Parameter | Type | Description | Example Value |
|---|---|---|---|
| logout | bool | Whether commented out. true: this instruction will not be executed in the job file; false: not commented, executable | false |
| type | int | Instruction type, string locate is 226 in the enumeration sequence | 226 |
| userParamInt | int | Customer custom in secondary development, currently no meaning | 0 |
| userParamString | string | Customer custom in secondary development, currently no meaning | "" |
| variable | object | The string variable name to be extracted; string type variable, global or local | {"data":0.0,"secondvalue":0,"value":8,"varname":"S001"} |
| startIndex | object | Character to search for; string type manual value or variable, global or local | {"data":0.0,"secondvalue":0,"value":7,"varname":"RRRR"} |
| dataVariable | object | First storage position for queried data; int type variable, global or local | {"data":0.0,"secondvalue":0,"value":8,"varname":"I001"} |
| dataStorage | object | Records the count of extracted data; string type manual "0" or int type variable, global or local. String type manual "0" means not used | {"data":0.0,"secondvalue":1,"value":8,"varname":"GI[GI001]"} |
JSON Example
json
{
"dataStorage": {"data": 0.0, "secondvalue": 1, "value": 8, "varname": "GI[GI001]"},
"dataVariable": {"data": 0.0, "secondvalue": 0, "value": 8, "varname": "I001"},
"logout": false,
"startIndex": {"data": 0.0, "secondvalue": 0, "value": 7, "varname": "RRRR"},
"type": 226,
"userParamInt": 0,
"userParamString": "",
"variable": {"data": 0.0, "secondvalue": 0, "value": 8, "varname": "S001"}
}5. String Length (STRING_LENGTH)
Description: Calculates the length of a string variable and stores the calculated length into a variable.
Instruction Name: STRING_LENGTH
type Value: 227
Parameter List
| Parameter | Type | Description | Example Value |
|---|---|---|---|
| logout | bool | Whether commented out. true: this instruction will not be executed in the job file; false: not commented, executable | false |
| type | int | Instruction type, string length is 227 in the enumeration sequence | 227 |
| userParamInt | int | Customer custom in secondary development, currently no meaning | 0 |
| userParamString | string | Customer custom in secondary development, currently no meaning | "" |
| variable | object | Variable where the character to locate resides; string type variable, global or local | {"data":0.0,"secondvalue":0,"value":8,"varname":"S001"} |
| dataVariable | object | Storage result for calculation; int type variable, global or local | {"data":0.0,"secondvalue":0,"value":8,"varname":"I001"} |
JSON Example
json
{
"dataVariable": {"data": 0.0, "secondvalue": 0, "value": 8, "varname": "I001"},
"logout": false,
"type": 227,
"userParamInt": 0,
"userParamString": "",
"variable": {"data": 0.0, "secondvalue": 0, "value": 8, "varname": "S001"}
}6. String to Non-String (STRING_TO)
Description: Converts a string variable to a non-string variable.
Conversion Rule: When converting a string variable to a non-string variable, only the numeric portion of the string variable is transferred to the non-string variable. During the conversion process, it starts translating from the first character of the string variable until a non-numeric character is detected, at which point the conversion ends. The detected numeric portion of characters is transferred to the non-string variable. If the first character detected is a non-numeric character, the string cannot be converted successfully.
Instruction Name: STRING_TO
type Value: 228
Parameter List
| Parameter | Type | Description | Example Value |
|---|---|---|---|
| logout | bool | Whether commented out. true: this instruction will not be executed in the job file; false: not commented, executable | false |
| type | int | Instruction type, string to non-string is 228 in the enumeration sequence | 228 |
| userParamInt | int | Customer custom in secondary development, currently no meaning | 0 |
| userParamString | string | Customer custom in secondary development, currently no meaning | "" |
| variable | object | Variable whose length is to be calculated; string type variable, global or local | {"data":0.0,"secondvalue":0,"value":8,"varname":"S001"} |
| nonVariable | object | Target variable for conversion; int type or double type or bool type variable, local or global | {"data":0.0,"secondvalue":0,"value":8,"varname":"I001"} |
JSON Example
json
{
"nonVariable": {"data": 0.0, "secondvalue": 0, "value": 8, "varname": "I001"},
"logout": false,
"type": 228,
"userParamInt": 0,
"userParamString": "",
"variable": {"data": 0.0, "secondvalue": 0, "value": 8, "varname": "S001"}
}7. Non-String to String (TO_STRING)
Description: Converts a non-string variable to a string variable.
Instruction Name: TO_STRING
type Value: 229
Parameter List
| Parameter | Type | Description | Example Value |
|---|---|---|---|
| logout | bool | Whether commented out. true: this instruction will not be executed in the job file; false: not commented, executable | false |
| type | int | Instruction type, non-string to string is 229 in the enumeration sequence | 229 |
| userParamInt | int | Customer custom in secondary development, currently no meaning | 0 |
| userParamString | string | Customer custom in secondary development, currently no meaning | "" |
| variable | object | Target variable for conversion; string type variable, global or local | {"data":0.0,"secondvalue":0,"value":8,"varname":"S001"} |
| nonVariable | object | Variable to be converted; int type or double type or bool type variable, local or global | {"data":0.0,"secondvalue":1,"value":8,"varname":"GI[GI001]"} |
JSON Example
json
{
"nonVariable": {"data": 0.0, "secondvalue": 1, "value": 8, "varname": "GI[GI001]"},
"logout": false,
"type": 229,
"userParamInt": 0,
"userParamString": "",
"variable": {"data": 0.0, "secondvalue": 0, "value": 8, "varname": "S001"}
}