ajCreateFolder function
Available since AlchemyJ v4.1.3
Description
The ajCreateFolder function creates a new folder in the specified folder path.
Syntax
ajCreateFolder (folder_path,[run_condition],[run_by_function_point_only])
| Argument Name | Argument Type | Description |
|---|---|---|
| folder_path (required) | String | The path of the new folder. It will create the parent folder automatically if the parent folder does not exist. Both the forward-slash (/) and backslash (\) are supported as the folder separator. |
| 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: TRUE, #VALUE!
2) Return Type: Single Value
Example
Example 1
=ajCreateFolder("c:\new_folder\sub_folder")
Using the above formula, it will create the new folder and subfolder under C drive, the function returns TRUE. If the folder path is not accessible, error #VALUE! would be returned.
Error Scenarios
It will return #VALUE! when missing any required parameter or mismatch parameter type.