UserParameters.importUserParameters Method
Parent Object: UserParameters
Defined in namespace "adsk::fusion" and the header file is <Fusion/Fusion/UserParameters.h>
Description
Function that imports a list of user parameters from a csv file.
The format of the csv file is as follows:
- It must have at least two rows - Header followed by a row of parameters.
- It must be encoded in UTF8 format.
- It must contain at least six columns - name, unit, expression, value, comment, and favorite, where favorite is either true or false.
- The columns must only have a comma delimiter.
- Any locale will work but no thousands separators.
- The expression column supports double quotes.
- The comment can either be single line or multi-line. If multi-line, it must be in double quotes.
Here is an example of a csv file with two rows:
Name,Unit,Expression,Value,Comments,Favorite p1,mm,32 mm,32,the first parameter,FALSE
The function exportUserParameters could be used to see what a csv file looks like.
Syntax
"userParameters_var" is a variable referencing a UserParameters object.returnValue = userParameters_var.importUserParameters(filename) |
"userParameters_var" is a variable referencing a UserParameters object.
#include <Fusion/Fusion/UserParameters.h>
returnValue = userParameters_var->importUserParameters(filename);
|
Return Value
| boolean |
Returns whether the import was successful. |
Parameters
| filename |
string |
The full filename (path and file) of the file to read the parameters from. |
Version
Introduced in version September 2024