ajBigStrLeft function
Description
Returns the specified number of characters from the start of Big String text.
Syntax
ajBigStrLeft(memory_id, [num_chars], [run_condition], [run_by_function_point_only])
| Argument Name | Argument Type | Description |
|---|---|---|
| memory_id (big string ID) (required) | String | The memory address id that keeps the Big String text. A big string ID can be retrieved from ajBigStrSet() or configure Big String value from More Tools tab in AlchemyJ ribbon. |
| num_chars (optional) | Long | Number of characters you want to extract. The default value is 1. |
| run_condition (optional) | Boolean | The function will run when the value is TRUE. Otherwise will not run. The default value is TRUE. |
| run_by_function_point_only (optional) | Boolean | If it equals FALSE, the function can be executed through ‘Excel Calculation’ (can be either Automatic or Manual, Calculate Now or Calculate Sheet) or Preview Function Point. If it equals TRUE, the function can be executed with Preview Function Point (AlchemyJ ribbon \ Preview Function Point) only. The default value is TRUE. |
The function will return:
1) Return Value: Big String
2) Return Type: Single Value
Example
In this example, we will demonstrate how to retrieve a specific number of characters starting from the left of the Big String. In this example, we would be retrieving the first 2 letters which would be 'ab'.
The Big String value we have used here is 'abc'. To use the ajBigStrLeft formula, firstly we have to convert 'abc' into a big string ID. This is done using the ajBigstrSet formula.
After converting into a big string ID, we can then use the formula as shown in B8 and it will return a Big String value.
To verify the result, we can use the ajBigStrValue formula in B10 to make it into a normal String. As seen in B11, we have successfully retrieved the first 2 letters which are 'ab'.
Error Scenarios
It will return #VALUE! when missing any required parameter or mismatch parameter type. Besides, system will raise error for below scenario(s).
| Error Scenario |
|---|
| Big String ID does not exist. |
| Num chars should be greater than or equal to zero. |