|toExportStruct||in||Row identifier, column identifier or identifier of local variable of Record type.|
|delimiter||in||Identifier of Text type - delimiter to be used in the CSV file.|
|fName||in||File name with extension.|
|timeZone||in||Parameter of Text, Int or Bool type - defines interpretation of timestamps.|
|retCodeIdent_Int||out||Return value of Int type - action success.|
|transPalIdx||in||Optional parameter of Int type.|
|ENCODING||in||Key word which is followed by a name of file encoding in the text format. The list of supported encodings in ESL.|
The action success is indicated by the output parameter retCodeIdent_Int. Value of 0 means the successful export, the value other than 0 means the error.
Depending on the parameter toExportStruct, the action exports:
- entire local variable
- row of local variable
- column of local variable
CSV file format
The local variable is saved to the specified CSV file row-by-row (row in a structure presents a row in a CSV file).
Because the CSV file format is not unique defined, the action awaits a delimiter as its second parameter. Delimiter is one character, that is to be used to separate items in the CSV file. Real numbers use the decimal separator '.'.
If the key word
is used, then the CSV file also contains the value time for each item. Time is presented before the item value. CSV file therefore contains the double number of columns.
If the key word UTF8 is used, the action generates a text file with UTF-8 encoding.
If the key word APPEND is used, the action inserts data into CSV file. In case that this file does not exist, it will be created.
Time can be formatted by the mask defined in the transformation palette - the index is given by parameter transPalIdx_Int.
If the parameter is not defined or its value is 0, there is used the mask dd.mm.rrrr hh:mi:ss.
If its value is -1, then values of Absolute time and Real types are to be converted according to the settings specified in the Regional and Language Options of the current user on Windows systems. For different operating systems the value of -1 will be automatically replaced with the value of 0.
The parameter timeZone defines export interpretation of timestamps. In case of empty text, timestamps are exported as local times. In case of defined time zone name (e.g. "Europe/London"), timestamps are exported as local times for given time zone. In case of integer value, timestamps are exported as times with fixed offset from UTC, where given value defines offset in seconds. For historical reasons boolean values are accepted: @FALSE - timestamps are exported as local times, @TRUE - timestamps are exported as times with fixed offset of 3600 seconds (1 hour) from UTC. Usage of boolean value @TRUE is not recommended and generates warning when ESL script is being saved. It is recommended to replace it with integer value.
The CSV delimiter (the parameter delimiter) may be obtained by calling the function %GetCSVDelimiter.
The object SD.ArchVal of Structure definition is defined with the columns:
There is defined the object SV.ArchVal of Structured variable. The structure type is SD.ArchVal. The number of rows: 3. Start values are:
The example does not test the action execution success.