XML GET OPTIONS
XML GET OPTIONS ( elementRef | document ; selector ; value {; selector2 ; value2 ; ... ; selectorN ; valueN} )
| Parameter | Type | Description | |
|---|---|---|---|
| elementRef | document | Text | → | XML root element reference or Reference of open document |
| selector | Integer | → | Option to get |
| value | Integer | ← | Current value of option |
Description
The XML GET OPTIONS command is used to get the current value of one or more XML parameters for the current session and the current user.
In selector, pass a constant of the "XML" theme indicating the option to get. The current value of the option is returned in the value parameter:
| Constant | Type | Value | Comment |
|---|---|---|---|
| XML binary encoding | Longint | 5 | Specifies the way binary data will be converted. Possible values: XML Base64 (default value): binary data are simply converted to Base64XML data URI scheme: binary data are converted to Base64 and the "data:;base64" header is added. This format mainly allows a browser to automatically decode a picture, and is also required for the insertion of pictures. For more information, see http://en.wikipedia.org/wiki/Data%5FURI%5Fscheme. |
| XML BOM | Longint | 9 | Specifies if XML documents include BOM. Possible values: XML default (default): use current database settings. By default, BOM is not included - except in databases/projects created with 4D versions up to v19.x, where BOM is included. See also Compatibility settings. XML enabled: include BOM XML disabled: do not include BOM |
| XML date encoding | Longint | 2 | Specifies the way 4D dates will be converted. For example, !01/01/2003! in the Paris time zone. Possible values: XML ISO (default value): use of the format xs:datetime without indication of time zone. Result: "2003-01-01". The time part, if it is present in the 4D value (via SQL) is lost. XML local: use of the format xs:date with indication of time zone. Result: "2003-01-01 +01:00". The time part, if it is present in the 4D value (via SQL) is lost. XML datetime local: use of the format xs:dateTime (ISO 8601). Indication of time zone. This format allows the time part to be kept, if it is present in the 4D value (via SQL). Result: " |
| XML DOM case sensitivity | Longint | 8 | Specifies the case sensitivity regarding element names for DOM Get XML element and DOM Count XML elements commands. Possible values: XML case sensitive (default value): commands are case sensitive.XML case insensitive: commands are not case sensitive. |
| XML external entity resolution | Longint | 7 | Controls whether external entities are resolved in XML documents. For security reasons, by default both DOM and SAX 4D XML parsers do not allow external entity resolution. Note that the scope of this selector is the calling process (if preemptive) or all cooperative processes (if called from a cooperative process). It globally applies to all XML documents (the first parameter is ignored, you can pass an empty string). Possible values: XML enabled: allow external entity resolution in XML documentsXML disabled (default value): disallow external entity resolution (an external entity declaration generates a parser error) |
| XML indentation | Longint | 4 | Specifies the indentation of the XML document. Possible values: XML with indentation (default value): the document is indented.XML no indentation: the document is not indented; its contents are placed in a single line. |
| XML line ending | Longint | 10 | End-of-line characters in written XML documents. Possible values: XML default (default): use current database settings. Default is LF on macOS and CRLF on Windows. However on macOS, in databases/projects created with 4D versions up to v19.x, default is CR for DOM and CRLF for SAX. See also Compatibility settings. XML LF: Use LF (line feed) XML CR: Use CR (carriage return) XML CRLF: Use CR+LF |
| XML picture encoding | Longint | 6 | Specifies the way pictures must be converted (before encoding in Base64). Possible values: XML convert to PNG (default value): pictures are converted to PNG before being encoded in Base64.XML native codec: pictures are converted in their first native storage CODEC before being encoded in Base64. You must use these options to encode SVG pictures (see example for the XML SET OPTIONS command). |
| XML string encoding | Longint | 1 | Specifies the way 4D strings are converted to element values. It does not concern the conversion to attributes for which XML imposes the use of escape characters. Possible values: XML with escaping (default value): conversion of 4D strings to XML element values with replacement of characters. The Text type data are automatically parsed so that forbidden characters (<&>’) are replaced by XML entities (&<> '").XML raw data: 4D strings are sent as raw data; 4D does not carry out encoding or parsing. 4D values are converted if possible to XML fragments and inserted as a child of the target element. If a value cannot be considered as an XML fragment, it is inserted as raw data into a new CDATA node. |
| XML time encoding | Longint | 3 | Specifies the way 4D times are converted. For example, ?02/00/46? (Paris time). The encoding differs depending on whether you want to express a time or a duration. Possible values for times: XML datetime UTC: time expressed in UTC (Universal Time Coordinated). Note that conversion to UTC is automatic. Result: " XML seconds: number of seconds since midnight; no modification of the value since it expresses a duration. Result: " |