|
save( [flags [, path [, encoding [, publicId [, systemId]]]]] )
|
|
|
Parameters
|
intflags
[optional] A bitmask that specifies save options. Constructed by ORing the bits from the SaveFlags enumeration.
Stringpath
[optional] Specifies the path name of the output file. It may be any of the following values:
• The name of a file. If it exists, it is silently rewritten.
• A WebDAV URL (Windows only).
• (UNIX only) A dash ("-") indicating standard input.
• An asterisk ("*") indicating the message window.
• (UNIX only) a UNIX pipeline ("|").
If the path is omitted or a null string, the document is saved to the original path name or Logical ID. If the document does not have a path, or if the path is not writable (for example, the document was read from an http: URL not on a WebDAV server, or the backing object was not checked out from the DMS), the method raises an exception.
Stringencoding
[optional] Determines the encoding of the file being written. This parameter overrides the encoding declaration in the document. The following table lists the valid strings for the encoding parameter.
Adobe-Standard-Encoding
ISO-8859-9
ISO-8859-1
EUC-JP
ISO-8859-1-Windows-3.1-Latin-1*
Shift_JIS
ISO-8859-2
Big5
ISO-8859-3
GB_2312-80
ISO-8859-4
KSC_5601
ISO-8859-5
UTF-8
ISO-8859-7
US-ASCII
ISO-8859-8
ISO-10646-UCS-2
*Windows only
If encoding is null or the empty string, the encoding is determined using the following rules:
• If the original document is an SGML document and the xml option is specified, the resulting XML file will use the original encoding if the SGML document has a byte-order mark (an ISO-10646-UCS-2 file) or a special encoding was set using edit encoding. If there was no special encoding or it is not an ISO-10646-UCS-2 file, the resulting XML file will use UTF-8 encoding. UTF-8 is the default encoding for XML documents.
• If the original document is an SGML document and either no option is specified or the sgml option is specified, the resulting SGML file will use the same encoding as the original document.
• If the original document is an XML document and the sgml option is specified, the resulting SGML file will use the encoding used by the operating system.
• If the original document is an XML document and either no option is specified or the xml option is specified, the resulting XML file will use the same encoding as the original document.
XML documents that do not contain an encoding declaration in their header are assumed to have the default XML encoding of UTF-8.
StringpublicId
[optional] If this parameter is not null and not an empty string, it is written as the public identifier of the DOCTYPE declaration instead of the original value (if any). If it is "<none>" then the PUBLIC identifier will be omitted.
StringsystemId
[optional] If this parameter is not null and not an empty string, it is written as the SYSTEM identifier on the DOCTYPE declaration. If it is "<none>", the SYSTEM identifier will be omitted.
If this option is null or an empty string, the Application.getOption("writeabsolutesysid") setting determines how the SYSTEM identifier is written.
|
|
Returns
|
void
|
|
Throws
|
AOMException
Raised if the method detects any error.
|