Promotic
WikipediaLinkedInYoutubeTwitterFacebook

SaveToFile - method of the PmaDataTable object

Description:
Saving data of this object into the file. of the CSV or DBF type. All columns and rows are saved.
Syntax:
Boolean SaveToFile(String sFile, String sParams)
Parameters:
sFile(String) The file name with the path into which the data have to be saved.
If a full path is not entered, then it is completed relative to the application folder.
It is recommended to use the PROMOTIC path syntax - see PROMOTIC path to files and folders.
sParams(String) Additional parameters that define the way of saving into the file. Entries are in KeyVal format, for example "filetype:csv;fmt:standard;".
"filetype:xxx;" (mandatory) - Specifies the type of the file specified in the sFile parameter. The following file types are possible:
csv - type is a CSV file. It is the multi-lined file of text values, for example, separated by semicolon. It is commonly used, for example, in the MsExcel program.
dbf - the type is a DBF file in the dBase III format. It is commonly used, for example, by the MsExcel program.
"fmt:xxx;" (optional) - Specifies the format of the data stored in the file. The following formats are possible:
"standard" (default) - (only for CSV) values from rows of the CSV file are stored into corresponding rows in the table
"head:xxx;" (optional) - (only for CSV)Specifies whether the single-line heading with the columns names is stored in the file. The allowed values are:
no (default) - Heading is not inserted.
name - Heading is inserted, there are variable names in the heading.
"delimiter:xxx;" (optional) - (only for CSV) The separator of values in the CSV file. The allowed values are:
semicolon (default) - the separator is a semicolon.
comma - the separator is a comma.
space - the separator is a space.
tab - the separator is a tab.
number - i.e. the separator is defined as a number of the ASCII character (in decimal), for example "delimiter:124;" means the "|" separator (vertical line).
"date.fmt:xxx;" (optional) - Date/time format. The allowed values are:
system (default) - the date/time format is set by OS Windows settings (e.g. 22.11.2010 16:30:15).
pm - PROMOTIC date/time format with 1 second accuracy (e.g. 2010.11.22 16:30:15).
pmmili - PROMOTIC date/time format - accuracy 10 ms (e.g. 2010.11.22 16:30:15.250).
real - data type of date/time format Date as a real number (e.g. 41392.123456789).
"real.dsep:xxx;" (optional) - (only for CSV) The format of decimal separator for real numbers. The allowed values are:
system (default) - the decimal separator is defined by OS Windows settings (e.g. 3,14).
dot - the decimal separator is (regardles on OS Windows settings) a period (e.g. 3.14).
comma - the decimal separator is (regardles on OS Windows settings) a comma (e.g. 3,14).
"lastcolsep:xxx;" (optional)
yes - When writing, the separator is added after the last value on the row, when reading, the empty value at the end of each row is ignored. From the CSV file standard point of view, this is not correct.
no (default) - The separators are present only between values on the same row, not at the end. From the CSV file standard point of view, this is correct.
"string.len:nnn;" (optional) - (only for DBF) Maximum string length. Default is 32.
Return values:
true - saving proceeded successfully
false - Otherwise
Example1:
Saving data into the Data.csv file in the application folder. The separator of values is semicolon, the decimal separator of real numbers is a period and the date will be stored in PROMOTIC system format.
JavaScriptVBScriptSelect and copy to clipboard

var oDataTable = pMe.Pm("/DataTable");
oDataTable.SaveToFile("#app:Data.csv", "filetype:csv;delimiter:semicolon;real.dsep:dot;date.fmt:pm;");
Example2:
Saving data into the Data.dbf file in the application folder. The date will be stored in PROMOTIC system format.
JavaScriptVBScriptSelect and copy to clipboard

var oDataTable = pMe.Pm("/DataTable");
oDataTable.SaveToFile("#app:Data.dbf", "filetype:dbf;date.fmt:pmmili;");

History:
Pm8.00.12: for DBF format return the true value after successfull save.
Pm8.00.09: Generalization by:
- the possibility to save data into dBase (DBF) file, see "filetype:dbf;".
- the possibility to define the decimal separator (comma or full stop), see the "real.dsep:xxx;" parameter.
- the possibility to define the format of date and time, see the "date.fmt:xxx;" parameter.
- the possibility to define maximum length of saved text, see the "string.len:nnn;" parameter.
PROMOTIC 9.0.16 SCADA system documentation - MICROSYS, spol. s r.o.

Send page remarkContact responsible person
© MICROSYS, spol. s r. o.Tavičská 845/21 703 00 Ostrava-Vítkovice