RTI_Stringbuilder function
Description
This function provides a utility to build and extract data from a string.
Syntax
retval = RTI_Stringbuilder( handle, method, param1, param2, param3)
Parameters
The function has the following parameters:
| Parameter | Description |
|---|---|
| handle | |
| method | Value - Description New - Creates a new string. Append - Appends a value to the end of an existing string. GetByteSize - Returns the size of the string in bytes. ToString - Returns the entire string. RemoveAt - Returns the string at a delimiter. Destroy - Destroys the handle. |
| param1 | Method - Value: Description New - numBtyes: The number of bytes to allocate for the string. If null, the function will allocate 64K. Append -String: The data to be appended to the string. GetByteSize - <null>: Not applicable ToString - Result: The string is returned in the first parameter. RemoveAt - Result: The string is returned in the first parameter. Destroy - <null>: Not applicable |
| param2 | Method - Value: Description New - <null>: Not applicable Append - <null>: Not applicable GetByteSize - <null>: Not applicable ToString - Boolean value: When True, the function will trim trailing system delimiters. The default is False. The system delimiters that will be removed are: @RM, @FM, @SVM, @TM. RemoveAt - Integer: The starting position of the next substring. Destroy - <null>: Not applicable |
| param3 | Method - Value: Description New - <null>: Not applicable Append - <null>: Not applicable GetByteSize - <null>: Not applicable ToString - <null>: Not applicable RemoveAt - Integer: The starting position of the next substring. Destroy - <null>: Not applicable |
Returns
| Method | Return Value |
|---|---|
| New | Not applicable |
| Append | The end position of the string. |
| GetByteSize | Returns the size of the string in bytes. |
| ToString | Returns the entire string. |
| RemoveAt | Returns the string at a delimiter. |
| Destroy | Not applicable. |