document() Function (SLAX)

Namespaces

SLAX Syntax

Description

Read data from a file or URL. The data can be encoded in any character set and can be BASE64 encoded. The default character set is "utf‑8". Optional arguments specify the character encoding scheme and the encoding format, and define the replacement string for non-XML control characters. Table 1 lists the available options.

Note:

Calling the document() function to read the same file multiple times within a script does not reflect any changes made to that file in the interim, because the file is cached when first read, and the original contents are returned every time the document() function retrieves the same file.

Parameters

options

(Optional) Specify the character encoding scheme and format of the data, and define the replacement string for non-XML control characters. Table 1 outlines the available options.

Table 1: Options for slax:document Function
Option	Description
`<encoding> string`	Character encoding scheme. For example "ascii" or "utf-8".
`<format> string`	"base64" for BASE64-encoded data.
`<non-xml> string`	String used to replace non-XML control characters. If the value is an empty string, non-XML characters are removed.

url

File or URL from which to read data.

Return Value

string

String representing the data.

Usage Examples

Release Information

Function introduced in version 1.1 of the SLAX language, which is supported in Junos OS Release 12.2 and later releases.

ON THIS PAGE