Functions: T¶
22 functions (25 overloads) on BasicRuntime.Functions starting with T.
TABLEADD¶
Performs the tableadd operation using the supplied tableArray, key, value.
| Kind | Method (static) |
| Returns | bool |
| Use case | Call Functions.TABLEADD(...) directly (no instance required) when your code needs to perform the tableadd operation using the supplied tableArray, key, value. |
How this member is tested
Act: var result = Functions.TABLEADD(/* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result matches the expected true/false outcome.
Expected: Returns true or false, indicating the outcome of the tableadd check for the given input.
TABLECLEAR¶
Performs the tableclear operation using the supplied tableArray.
| Kind | Method (static) |
| Returns | bool |
| Use case | Call Functions.TABLECLEAR(...) directly (no instance required) when your code needs to perform the tableclear operation using the supplied tableArray. |
How this member is tested
Act: var result = Functions.TABLECLEAR(/* a valid DynamicArray value */)
Assert: result matches the expected true/false outcome.
Expected: Returns true or false, indicating the outcome of the tableclear check for the given input.
TABLEFIND¶
Performs the tablefind operation using the supplied tableArray, key.
| Kind | Method (static) |
| Returns | bool |
| Use case | Call Functions.TABLEFIND(...) directly (no instance required) when your code needs to perform the tablefind operation using the supplied tableArray, key. |
How this member is tested
Act: var result = Functions.TABLEFIND(/* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result matches the expected true/false outcome.
Expected: Returns true or false, indicating the outcome of the tablefind check for the given input.
TABLEGET¶
Performs the tableget operation using the supplied tableArray, key.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.TABLEGET(...) directly (no instance required) when your code needs to perform the tableget operation using the supplied tableArray, key. |
How this member is tested
Act: var result = Functions.TABLEGET(/* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.
Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.
TABLEREMOVE¶
Performs the tableremove operation using the supplied tableArray, key.
| Kind | Method (static) |
| Returns | bool |
| Use case | Call Functions.TABLEREMOVE(...) directly (no instance required) when your code needs to perform the tableremove operation using the supplied tableArray, key. |
How this member is tested
Act: var result = Functions.TABLEREMOVE(/* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result matches the expected true/false outcome.
Expected: Returns true or false, indicating the outcome of the tableremove check for the given input.
TABLESELECT¶
Performs the tableselect operation using the supplied tableArray, listNo.
| Kind | Method (static) |
| Returns | bool |
| Use case | Call Functions.TABLESELECT(...) directly (no instance required) when your code needs to perform the tableselect operation using the supplied tableArray, listNo. |
How this member is tested
Act: var result = Functions.TABLESELECT(/* a valid DynamicArray value */, 1)
Assert: result matches the expected true/false outcome.
Expected: Returns true or false, indicating the outcome of the tableselect check for the given input.
TCLSELECT¶
static void Functions.TCLSELECT(DynamicArray fileVariable, int listNumber, DatabaseQuery dbQuery, Itypes itype)
Performs the tclselect operation using the supplied fileVariable, listNumber, dbQuery, itype.
| Kind | Method (static) |
| Returns | void |
| Use case | Call Functions.TCLSELECT(...) directly (no instance required) when your code needs to perform the tclselect operation using the supplied fileVariable, listNumber, dbQuery, itype. |
How this member is tested
Act: Functions.TCLSELECT(/* a valid DynamicArray value */, 1, /* a valid DatabaseQuery value */, /* a valid Itypes value */)
Assert: no exception is thrown and the expected side effect occurred.
Expected: No return value; verify the intended side effect occurred (state change, event raised, or exception NOT thrown for valid input).
TEXTTOPDF¶
Overload 1
static int Functions.TEXTTOPDF(DynamicArray sourceFile, DynamicArray pdfFile, DynamicArray pdfTemplateFile, DynamicArray fontName, DynamicArray fontSize, DynamicArray orientation, DynamicArray topMargin, DynamicArray leftMargin, DynamicArray paperSize, DynamicArray ignoreFF)
Performs the texttopdf operation using the supplied sourceFile, pdfFile, pdfTemplateFile, fontName, fontSize, orientation, topMargin, leftMargin, paperSize, ignoreFF.
| Kind | Method (static) |
| Returns | int |
| Use case | Call Functions.TEXTTOPDF(...) directly (no instance required) when your code needs to perform the texttopdf operation using the supplied sourceFile, pdfFile, pdfTemplateFile, fontName, fontSize, orientation, topMargin, leftMargin, paperSize, ignoreFF. |
How this member is tested
Act: var result = Functions.TEXTTOPDF(/* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result equals the expected computed value.
Expected: Returns a int value; verify it equals the expected computed result for the given input.
Overload 2
static int Functions.TEXTTOPDF(DynamicArray sourceFile, DynamicArray pdfFile, DynamicArray fontName, DynamicArray fontSize, DynamicArray orientation, DynamicArray topMargin, DynamicArray leftMargin, DynamicArray paperSize, DynamicArray ignoreFF)
Performs the texttopdf operation using the supplied sourceFile, pdfFile, fontName, fontSize, orientation, topMargin, leftMargin, paperSize, ignoreFF.
| Kind | Method (static) |
| Returns | int |
| Use case | Call Functions.TEXTTOPDF(...) directly (no instance required) when your code needs to perform the texttopdf operation using the supplied sourceFile, pdfFile, fontName, fontSize, orientation, topMargin, leftMargin, paperSize, ignoreFF. |
How this member is tested
Act: var result = Functions.TEXTTOPDF(/* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result equals the expected computed value.
Expected: Returns a int value; verify it equals the expected computed result for the given input.
TIME¶
Performs the time operation.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.TIME(...) directly (no instance required) when your code needs to perform the time operation. |
How this member is tested
Act: var result = Functions.TIME()
Assert: result is a non-null instance whose state matches expectations.
Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.
TIMEDATE¶
Performs the timedate operation.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.TIMEDATE(...) directly (no instance required) when your code needs to perform the timedate operation. |
How this member is tested
Act: var result = Functions.TIMEDATE()
Assert: result is a non-null instance whose state matches expectations.
Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.
TIMEOUT¶
Performs the timeout operation using the supplied fileVariable, timeout.
| Kind | Method (static) |
| Returns | void |
| Use case | Call Functions.TIMEOUT(...) directly (no instance required) when your code needs to perform the timeout operation using the supplied fileVariable, timeout. |
How this member is tested
Act: Functions.TIMEOUT(/* a valid DynamicArray value */, 1)
Assert: no exception is thrown and the expected side effect occurred.
Expected: No return value; verify the intended side effect occurred (state change, event raised, or exception NOT thrown for valid input).
TRACE¶
Performs the trace operation.
| Kind | Method (static) |
| Returns | void |
| Use case | Call Functions.TRACE(...) directly (no instance required) when your code needs to perform the trace operation. |
How this member is tested
Act: Functions.TRACE()
Assert: no exception is thrown and the expected side effect occurred.
Expected: No return value; verify the intended side effect occurred (state change, event raised, or exception NOT thrown for valid input).
trailingSpaceDecode¶
Performs the trailing space decode operation using the supplied keyCheck.
| Kind | Method (static) |
| Returns | string |
| Use case | Call Functions.trailingSpaceDecode(...) directly (no instance required) when your code needs to perform the trailing space decode operation using the supplied keyCheck. |
How this member is tested
Act: var result = Functions.trailingSpaceDecode("sample")
Assert: result is non-null and matches the expected text.
Expected: Returns a string value; verify it is non-null and matches the expected content.
trailingSpaceEncode¶
Performs the trailing space encode operation using the supplied keyCheck.
| Kind | Method (static) |
| Returns | string |
| Use case | Call Functions.trailingSpaceEncode(...) directly (no instance required) when your code needs to perform the trailing space encode operation using the supplied keyCheck. |
How this member is tested
Act: var result = Functions.trailingSpaceEncode("sample")
Assert: result is non-null and matches the expected text.
Expected: Returns a string value; verify it is non-null and matches the expected content.
TRANS¶
static DynamicArray Functions.TRANS(DynamicArray fileName, DynamicArray recordId, DynamicArray fieldNumber, DynamicArray controlCode)
Performs the trans operation using the supplied fileName, recordId, fieldNumber, controlCode.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.TRANS(...) directly (no instance required) when your code needs to perform the trans operation using the supplied fileName, recordId, fieldNumber, controlCode. |
How this member is tested
Act: var result = Functions.TRANS(/* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.
Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.
TRANS1¶
static DynamicArray Functions.TRANS1(DynamicArray fileName, DynamicArray recordId, DynamicArray fieldNumber, DynamicArray controlCode)
Performs the trans1 operation using the supplied fileName, recordId, fieldNumber, controlCode.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.TRANS1(...) directly (no instance required) when your code needs to perform the trans1 operation using the supplied fileName, recordId, fieldNumber, controlCode. |
How this member is tested
Act: var result = Functions.TRANS1(/* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.
Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.
TRIM¶
Overload 1
Performs the trim operation using the supplied value.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.TRIM(...) directly (no instance required) when your code needs to perform the trim operation using the supplied value. |
How this member is tested
Act: var result = Functions.TRIM(/* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.
Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.
Overload 2
Performs the trim operation using the supplied value, trimChar.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.TRIM(...) directly (no instance required) when your code needs to perform the trim operation using the supplied value, trimChar. |
How this member is tested
Act: var result = Functions.TRIM(/* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.
Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.
Overload 3
static DynamicArray Functions.TRIM(DynamicArray value, DynamicArray trimChar, DynamicArray trimType)
Performs the trim operation using the supplied value, trimChar, trimType.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.TRIM(...) directly (no instance required) when your code needs to perform the trim operation using the supplied value, trimChar, trimType. |
How this member is tested
Act: var result = Functions.TRIM(/* a valid DynamicArray value */, /* a valid DynamicArray value */, /* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.
Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.
TRIMB¶
Performs the trimb operation using the supplied value.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.TRIMB(...) directly (no instance required) when your code needs to perform the trimb operation using the supplied value. |
How this member is tested
Act: var result = Functions.TRIMB(/* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.
Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.
TRIMBS¶
Performs the trimbs operation using the supplied value.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.TRIMBS(...) directly (no instance required) when your code needs to perform the trimbs operation using the supplied value. |
How this member is tested
Act: var result = Functions.TRIMBS(/* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.
Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.
TRIMF¶
Performs the trimf operation using the supplied value.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.TRIMF(...) directly (no instance required) when your code needs to perform the trimf operation using the supplied value. |
How this member is tested
Act: var result = Functions.TRIMF(/* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.
Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.
TRIMFS¶
Performs the trimfs operation using the supplied value.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.TRIMFS(...) directly (no instance required) when your code needs to perform the trimfs operation using the supplied value. |
How this member is tested
Act: var result = Functions.TRIMFS(/* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.
Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.
TRIMS¶
Performs the trims operation using the supplied value.
| Kind | Method (static) |
| Returns | DynamicArray |
| Use case | Call Functions.TRIMS(...) directly (no instance required) when your code needs to perform the trims operation using the supplied value. |
How this member is tested
Act: var result = Functions.TRIMS(/* a valid DynamicArray value */)
Assert: result is a non-null instance whose state matches expectations.
Expected: Returns an instance of DynamicArray; verify its properties reflect the expected resulting state.