SaveAs – PB Docs 2019

Description

Saves the contents of a DataWindow or DataStore in the format you
specify.

For syntax to save the contents of graphs in DataWindows and
DataStores, see SaveAs. For syntax
to save objects in OLE controls and OLE storage, see SaveAs in PowerScript Reference.

Applies to

Syntax

PowerBuilder

Return value

Returns 1 if it succeeds and -1 if an error occurs. If any
argument’s value is null, SaveAs returns null.

Usage

If you do not specify any arguments for SaveAs, PowerBuilder
displays the Save As dialog box. A drop-down list lets the user specify
the format of the saved data.

Report format (PSReport! value of SaveAsType) is the best choice if
the DataWindow is a composite report. Choosing PSReport! has no effect if
the DataWindow object has the RichText presentation style.

For XML!, the XML logical structure used is based on the current XML
export template for the DataWindow object. You can change the export
template by setting the value of the Export.XML.UseTemplate property. If
no export template is specified, the default template is used.

If you use date formats in your report, you must verify that yyyy is
the Short Date Style for year in the Regional Settings of the user’s
Control Panel. Your program can check this with the RegistryGet function.
If the setting is not correct, you can ask the user to change it manually
or to have the application change it (by calling the RegistrySet
function). The user might need to reboot after the setting is
changed.

When you save the contents of a DataWindow to a text file, double
quotes are handled in a way that enables the ImportFile method to produce
the same DataWindow when the text file is imported back into PowerBuilder.
Any field that is enclosed in a pair of double quotes is wrapped with
three pairs of double quotes in the saved text file. Double quotes at the
beginning of a text field that have no matching double quotes at the end
of the field are also replaced by three double quotes in the saved text
file. However, a double quote elsewhere in the field is saved as one
double quote.

The behavior of the SaveAs method with the EncodingANSI! parameter
or with no encoding parameter is platform dependent. On the Windows and
Solaris platforms, the file is always saved with ANSI encoding whether you
are connected to an ANSI or Unicode database. On the Linux platform with
an ANSI database connection, SaveAs saves the file with ANSI encoding. On
the Linux platform with a Unicode database connection, if the data
contains multilanguage characters, SaveAs converts the characters to UTF-8
and saves the file with UTF-8 encoding.

Examples

This statement saves the contents of dw_History to the file
G:INVENTORYEMPLOYEE.HIS. The saved file is in CSV format without column
headings:

The following statements set the template used by the DataWindow
dw_1 to t_report, specify that metadata in the XMLSchema! format should be
generated in a separate file, and generate the files c:myxml.xml
containing the DataWindow row data in XML format, and c:myxml.xsd
containing the XML schema used in c:myxml.xml:

The following statements generate the files c:dw_one.fo containing
the DataWindow presentation and data in XSL-FO format, and c:dw_one.pdf
containing the DataWindow presentation and data in PDF format:

See also

ImportFile

Print

SaveAsFormattedText

Update