ajBigStrValue function
Description
Shows the value of a big string. Only the first 32767 characters are shown.
Syntax
ajBigStrValue(memory_id, [run_condition], [run_by_function_point_only])
| Argument Name | Argument Type | Description |
|---|---|---|
| memory_id (big string ID) (required) | String | The ID of the big string which you want to retrieve the value. A big string ID can be retrieved from ajBigStrSet() or configure Big String value from More Tools tab in AlchemyJ ribbon. |
| 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 show the value of a passed big string ID.
The Big String value we have used here is 'abc'. To use the ajBigStrValue 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 B5 and it will return a Big String value.
To verify the result, we can use the ajBigStrValue formula in B7 to make it into a normal String. As seen in B8, we have successfully retrieved 'abc' from the passed big string ID.
Error Scenarios
It will return #VALUE! when missing any required parameter or mismatch parameter type. Besides, system will also raise error for below scenario(s).
| Error Scenario |
|---|
| Big String ID does not exist. |