EXPath File Module 4.0

1.1 Error management

Error conditions are identified by a code (a QName.) When such an error condition is reached in the evaluation of an expression, a dynamic error is thrown, with the corresponding error code (as if the standard XPath function error() had been called.)

In this specification these codes use the http://expath.org/ns/file namespace and a 'descriptive string' local part, e.g. [file:not-found], rather than the http://www.w3.org/2005/xqt-errors namespace and alpha-numeric local part, e.g. err:FOCH0004, used in [XQuery and XPath Functions and Operators 4.0]. These error codes were chosen originally in the 1.0 version of 2013.

1.2 File Paths

All file paths are specified as strings, and are resolved against the current working directory. The current working directory is implementation-defined: It can e. g. be the file system directory from which a query processor was started.

An implementation must accept absolute and relative UNIX/Linux and Windows paths as well as absolute file URIs. Some examples:

• C:\Test Dir\my file.xml: An absolute path on Windows platforms.

• /Test Dir/my file.xml: An absolute path on UNIX-based platforms.

• C:\\\Test Dir//\\my file.xml: An absolute path on Windows platforms that tolerates an arbitrary number of slashes and backslashes.

• my file.xml: A relative path, pointing to a file in the current working directory.

• file:///C:/Test%20Dir/my%20file.xml: An absolute file URI on Windows platforms.

• file:///Test%20Dir/my%20file.xml: An absolute path on UNIX-based platforms.

Before further processing, all paths are normalized to an implementation-defined^FO representation (which usually is the representation of the underlying operating system).

It is implementation-defined^FO as to whether the error [file:invalid-path] is raised if a path is invalid.

If a function returns a string that refers to a directory, it will always be suffixed with the system-specific directory separator.

The function file:base-dir can be used to resolve file operations against the directory of the base URI:

let $filename := "input.txt"
let $dir := file:base-dir() 
let $path := concat($dir, $filename)
return file:read-text($path)

1.3 Function Execution

Almost all of these functions are marked as nondeterministic^FO, which means they are not guaranteed to perform the same operations and produce identical results from repeated calls. A processor must ensure that these functions are not relocated or pre-evaluated and that its results are not cached when compiling and evaluating the query and serializing its results.

1.4 Test suite

A suite of test-cases for all the functions defined in this module, in [QT3] format, is defined at [Test-suite].

1.5 Conformance

This specification follows the general remarks on and terminology for conformance given in Section 1.2 Conformance^FO

In this document, text labeled as an example or as a note is provided for explanatory purposes and is not normative.

1.6 Namespaces and prefixes

The functions defined in this document are contained exclusively in the namespace http://expath.org/ns/file and referenced using a xs:QName binding to that namespace.

This document uses the prefix file to refer to this namespace. User-written applications can choose a different prefix to refer to the namespace, so long as it is bound to the correct URI. In accordance with current practice, it is recommended that the prefix file be reserved for use with this namespace.

1.7 Function signatures and descriptions

Each function (or group of functions having the same name) is defined in this specification using a standard proforma, full details of which can be found in Section 1.5 Function signatures and descriptions^FO. In particular in this update (trailing) optional arguments for functions (introduced in XPath 4.0) are used where appropriate in the signatures, rather than multiple-arity signatures as previously.

2.1 file:exists

Summary

Tests if a file or directory exists.

Signature

file:exists(
$path	as xs:string
) as xs:boolean

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns true if $path points to a file or directory, false otherwise.

On UNIX-based systems the root and the volume roots are considered directories.

2.2 file:is-dir

Summary

Tests if $path points to a directory.

Signature

file:is-dir(
$path	as xs:string
) as xs:boolean

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns true if $path points to a directory, false otherwise.

On UNIX-based systems the root and the volume roots are considered directories.

2.3 file:is-file

Summary

Tests if $path points to a file.

Signature

file:is-file(
$path	as xs:string
) as xs:boolean

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns true if $path points to a existing file.

Returns false if $path points to a existing directory.

Otherwise returns false

2.4 file:last-modified

Summary

Returns the last modification time of a file or directory.

Signature

file:last-modified(
$path	as xs:string
) as xs:dateTime

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns the last modification time of a file or directory.

Error Conditions

[file:not-found] is raised if $path does not exist.

[file:io-error] is raised if any other error occurs.

2.5 file:size

Summary

Returns the byte size of a file, or the value 0 for directories.

Signature

file:size(
$file	as xs:string
) as xs:integer

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns 0 if $file points to a directory.

Returns the byte size of the file $file, if it exists.

Error Conditions

[file:not-found] is raised if $path does not exist.

[file:io-error] is raised if any other error occurs.

3.1 file:copy

Summary

Copies a file or a directory given a source and a target path/URI.

Signature

file:copy(
$source	as xs:string,
$target	as xs:string
) as empty-sequence()

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Copies a file or a directory given a source and a target path/URI. The following cases may occur if $source points to a file:

1. if $target does not exist, it will be created.

2. if $target is a file, it will be overwritten.

3. if $target is a directory, the file will be created in that directory with the name of the source file. If a file already exists, it will be overwritten.

The following cases may occur if $source points to a directory:

1. if $target does not exist, it will be created as directory, and all files of the source directory are copied to this directory with their existing local names.

2. if $target is a directory, the source directory with all its files will be copied into the target directory. At each level, if a file already exists in the target with the same name as in the source, it is overwritten. If a directory already exists in the target with the same name as in the source, it is not removed, it is recursed in place (if it does not exist, it is created before recursing).

Other cases will raise one of the errors listed below.

The function returns the empty sequence if the operation is successful. If an error occurs during the operation, no rollback to the original state will be possible

Error Conditions

[file:not-found] is raised if the $source path does not exist.

[file:exists] is raised if $source points to a directory and $target points to an existing file.

[file:no-dir] is raised if the parent directory of $source does not exist.

[file:is-dir] is raised if $source points to a file and $target points to a directory, in which a subdirectory exists with the name of the source file.

[file:io-error] is raised if any other error occurs.

3.2 file:create-dir

Summary

Creates a directory if it does not already exist.

Signature

file:create-dir(
$dir	as xs:string
) as empty-sequence()

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Creates a directory, or does nothing if the directory already exists. The operation will create all non-existing parent directories.

The function returns the empty sequence if the operation is successful.

Error Conditions

[file:exists] is raised if the specified path, or any of its parent directories, points to an existing file.

[file:io-error] is raised if any other error occurs.

3.3 file:create-temp-dir

Summary

Creates a temporary directory.

Signature

file:create-temp-dir(
$prefix	as xs:string,
$suffix	as xs:string,
$dir	as xs:string?	:= ()
) as xs:string

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Creates a temporary directory and all non-existing parent directories and returns the full path to the created directory.

The temporary directory will not be automatically deleted after query execution. It is guaranteed to not already exist when the function is called.

If $dir is omitted or an empty sequence, the directory will be created inside the system-dependent default temporary-file directory.

Error Conditions

[file:no-dir] is raised if the specified directory does not exist or points to a file.

[file:io-error] is raised if any other error occurs.

3.4 file:create-temp-file

Summary

Creates a temporary file.

Signature

file:create-temp-file(
$prefix	as xs:string,
$suffix	as xs:string,
$dir	as xs:string?	:= ()
) as xs:string

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Creates a temporary file and all non-existing parent directories and returns the full path to the created file.

The temporary file will not be automatically deleted after query execution. It is guaranteed to not already exist when the function is called.

If $dir is omitted or an empty sequence, the file will be created inside the system-dependent default temporary-file directory.

Error Conditions

[file:no-dir] is raised if the specified does not exist or points to a file.

[file:io-error] is raised if any other error occurs.

3.5 file:delete

Summary

Deletes a file or a directory from the file system.

Signature

file:delete(
$path	as xs:string,
$recursive	as xs:boolean?	:= false()
) as empty-sequence()

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Deletes a file or a directory from the file system.

If the optional parameter $recursive is true, sub-directories will be deleted as well.

The function returns the empty sequence if the operation is successful.

Error Conditions

[file:not-found] is raised if $path does not exist.

[file:is-dir] is raised if $file points to a non-empty directory.

[file:io-error] is raised if any other error occurs.

3.6 file:list

Summary

Lists all files and directories in a given directory.

Signature

file:list(
$dir	as xs:string,
$recursive	as xs:boolean?	:= false(),
$pattern	as xs:string?	:= ()
) as xs:string*

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Lists all files and directories in a given directory. The order of the items in the resulting sequence is not defined. The "." and ".." items are never returned. The returned paths are relative to the provided directory $dir.

If the optional parameter $recursive is true, all directories and files will be returned that are found while recursively traversing the given directory. If $recursive is omitted or an empty sequence or false only the contents of the specified directory will be returned.

The optional $pattern parameter defines a name pattern in the glob syntax. If this is provided and is not an empty sequence, only the paths of the files and directories whose names are matching the pattern will be returned.

An implementation must support at least the following glob syntax for the pattern:

• * for matching any number of unknown characters and

• ? for matching one unknown character.

A related function is file:children.

Error Conditions

[file:no-dir] is raised if $dir does not point to an existing directory.

[file:io-error] is raised if any other error occurs.

3.7 file:move

Summary

Moves a file or a directory.

Signature

file:move(
$source	as xs:string,
$target	as xs:string
) as empty-sequence()

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Moves a file or a directory given a source and a target path/URI. The following cases may occur if $source points to a file:

1. if $target does not exist, it will be created.

2. if $target is a file, it will be overwritten.

3. if $target is a directory, the file will be created in that directory with the name of the source file. If a file already exists, it will be overwritten.

The following cases may occur if $source points to a directory:

1. if $target does not exist, it will be created as directory, and all files of the source directory are moved to this directory with their existing local names.

2. if $target is a directory, the source directory with all its files will be moved into the target directory. If the target directory contains a directory with the same name as the source, the error [file:is-dir] is raised.

Other cases will raise one of the errors listed below.

The function returns the empty sequence if the operation is successful. If an error occurs during the operation, no rollback to the original state will be possible

Error Conditions

[file:not-found] is raised if the $source path does not exist.

[file:exists] is raised if $source points to a directory and $target points to an existing file.

[file:no-dir] is raised if the parent directory of $source does not exist.

[file:is-dir] is raised if $target points to a directory, in which a subdirectory exists with the name of the source.

[file:io-error] is raised if any other error occurs.

4.1 file:append

Summary

Appends a sequence of items to a file. If the file pointed by $file does not exist, a new file will be created.

Signature

file:append(
$file	as xs:string,
$items	as item()*,
$params	as element(output:serialization-parameters)?	:= ()
) as empty-sequence()

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Appends a sequence of items to a file.

If the file pointed by $file does not exist, a new file will be created.

$params, if not an empty sequence, controls the way the $items items are serialized. The semantics of $params are those of the same argument of Section 14.1.3 fn:serialize^FO, consisting of an output:serialization-parameters element whose format is defined in Section 3.1 Setting Serialization Parameters by Means of a Parameter Document^SE. In contrast to fn:serialize, the encoding stage will not be skipped by this function.

The function returns the empty sequence if the operation is successful.

Error Conditions

[file:no-dir] is raised if the parent directory of $file does not exist.

[file:is-dir] is raised if $file points to a directory.

[file:io-error] is raised if any other error occurs.

4.2 file:append-binary

Summary

Appends a Base64 item as binary data to a file.

Signature

file:append-binary(
$file	as xs:string,
$value	as xs:base64Binary
) as empty-sequence()

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Appends a Base64 item as binary data to a file.

If the file pointed to by $file does not exist, a new file will be created.

The function returns the empty sequence if the operation is successful.

Error Conditions

[file:no-dir] is raised if the parent directory of $file does not exist.

[file:is-dir] is raised if $file points to a directory.

[file:io-error] is raised if any other error occurs.

4.3 file:append-text

Summary

Appends a string to a file.

Signature

file:append-text(
$file	as xs:string,
$value	as xs:string,
$encoding	as xs:string?	:= 'utf-8'
) as empty-sequence()

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Appends a string to the file $file.

If the file pointed to by $file does not exist, a new file will be created.

The optional parameter $encoding, if omitted or an empty sequence, is considered to be UTF-8.

The function returns the empty sequence if the operation is successful.

Error Conditions

[file:no-dir] is raised if the parent directory of $file does not exist.

[file:is-dir] is raised if $file points to a directory.

[file:unknown-encoding] is raised if $encoding is invalid or not supported by the implementation.

[file:io-error] is raised if any other error occurs.

4.4 file:append-text-lines

Summary

Appends a sequence of strings to a file, each followed by the system-dependent newline character.

Signature

file:append-text-lines(
$file	as xs:string,
$lines	as xs:string*,
$encoding	as xs:string?	:= 'utf-8'
) as empty-sequence()

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Appends a sequence of strings to a file, each followed by the system-dependent newline character.

If the file pointed to by $file does not exist, a new file will be created.

The optional parameter $encoding, if omitted or an empty sequence, is considered to be UTF-8.

The function returns the empty sequence if the operation is successful.

Error Conditions

[file:no-dir] is raised if the parent directory of $file does not exist.

[file:is-dir] is raised if $file points to a directory.

[file:unknown-encoding] is raised if $encoding is invalid or not supported by the implementation.

[file:io-error] is raised if any other error occurs.

4.5 file:read-binary

Summary

Returns the content of a file in its Base64 representation.

Signature

file:read-binary(
$file	as xs:string,
$offset	as xs:integer?	:= 0,
$length	as xs:integer?	:= ()
) as xs:base64Binary

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns the content of a file in its Base64 representation.

The optional parameters $offset and $length can be used to read chunks of a file.

Error Conditions

[file:not-found] is raised if $file does not exist.

[file:is-dir] is raised if $file points to a directory.

[file:out-of-range] is raised if $offset or $length is negative, or if the chosen values would exceed the file bounds.

[file:io-error] is raised if any other error occurs.

4.6 file:read-text

Summary

Returns the content of a file in its string representation.

Signature

file:read-text(
$file	as xs:string,
$encoding	as xs:string?	:= 'utf-8'
) as xs:string

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns the content of a file in its string representation.

The optional parameter $encoding, if omitted or an empty sequence, is considered to be UTF-8.

Error Conditions

[file:not-found] is raised if $file does not exist.

[file:is-dir] is raised if $file points to a directory.

[file:unknown-encoding] is raised if $encoding is invalid or not supported by the implementation.

[file:io-error] is raised if any other error occurs.

4.7 file:read-text-lines

Summary

Returns the contents of a file as a sequence of strings, separated at newline boundaries.

Signature

file:read-text-lines(
$file	as xs:string,
$encoding	as xs:string?	:= 'utf-8'
) as xs:string*

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns the contents of a file as a sequence of strings, separated at newline boundaries.

The optional parameter $encoding, if omitted or an empty sequence, is considered to be UTF-8.

The newline handling is the same as for Section 13.6.6 fn:unparsed-text-lines^FO.

Error Conditions

[file:not-found] is raised if $file does not exist.

[file:is-dir] is raised if $file points to a directory.

[file:unknown-encoding] is raised if $encoding is invalid or not supported by the implementation.

[file:io-error] is raised if any other error occurs.

4.8 file:write

Summary

Writes a sequence of items to a file.

Signature

file:write(
$file	as xs:string,
$items	as item()*,
$params	as element(output:serialization-parameters)?	:= ()
) as empty-sequence()

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Writes a sequence of items to a file.

If $file already exists, it will be overwritten; otherwise, it will be created.

$params, if not an empty sequence, controls the way the $items items are serialized. The semantics of $params are those of the same argument of Section 14.1.3 fn:serialize^FO, consisting of an output:serialization-parameters element whose format is defined in Section 3.1 Setting Serialization Parameters by Means of a Parameter Document^SE. In contrast to fn:serialize, the encoding stage will not be skipped by this function.

The function returns the empty sequence if the operation is successful.

Error Conditions

[file:no-dir] is raised if the parent directory of $file does not exist.

[file:is-dir] is raised if $file points to a directory.

[file:io-error] is raised if any other error occurs.

4.9 file:write-binary

Summary

Writes a Base64 item as binary to a file.

Signature

file:write-binary(
$file	as xs:string,
$value	as xs:base64Binary,
$offset	as xs:integer?	:= 0
) as empty-sequence()

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Writes a Base64 item as binary to a file.

If $file already exists, it will be overwritten; otherwise, it will be created.

If the optional parameter $offset is specified and not set to an empty sequence, data will be written starting at this file position. An existing file may be resized by such an operation.

The function returns the empty sequence if the operation is successful.

Error Conditions

[file:no-dir] is raised if the parent directory of $file does not exist.

[file:is-dir] is raised if $file points to a directory.

[file:out-of-range] is raised if $offset is negative, or if it exceeds the current file size.

[file:io-error] is raised if any other error occurs.

4.10 file:write-text

Summary

Writes a string to a file.

Signature

file:write-text(
$file	as xs:string,
$value	as xs:string,
$encoding	as xs:string?	:= 'utf-8'
) as empty-sequence()

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Writes a strings to a file.

If $file already exists, it will be overwritten.

The optional parameter $encoding, if omitted or an empty sequence, is considered to be UTF-8.

The function returns the empty sequence if the operation is successful.

Error Conditions

[file:no-dir] is raised if the parent directory of $file does not exist.

[file:is-dir] is raised if $file points to a directory.

[file:unknown-encoding] is raised if $encoding is invalid or not supported by the implementation.

[file:io-error] is raised if any other error occurs.

4.11 file:write-text-lines

Summary

Writes a sequence of strings to a file, each followed by the system-dependent newline character.

Signature

file:write-text-lines(
$file	as xs:string,
$values	as xs:string*,
$encoding	as xs:string?	:= 'utf-8'
) as empty-sequence()

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Writes a sequence of strings to a file, each followed by the system-dependent newline character.

If $file already exists, it will be overwritten; otherwise, it will be created.

The optional parameter $encoding, if omitted or an empty sequence, is considered to be UTF-8.

The function returns the empty sequence if the operation is successful.

Error Conditions

[file:no-dir] is raised if the parent directory of $file does not exist.

[file:is-dir] is raised if $file points to a directory.

[file:unknown-encoding] is raised if $encoding is invalid or not supported by the implementation.

[file:io-error] is raised if any other error occurs.

5.1 file:name

Summary

Returns the name of a file or directory.

Signature

file:name(
$path	as xs:string
) as xs:string

Properties

This function is deterministic^FO, context-independent^FO, and focus-independent^FO.

Rules

Returns the name of a file or directory.

An empty string is returned if the path points to the root directory, or if it contains no directory separators.

This function is deterministic^FO (no path existence check is made).

5.2 file:parent

Summary

Returns the parent directory of a given path.

Signature

file:parent(
$path	as xs:string
) as xs:string?

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Transforms the given path into an absolute path, as specified by file:resolve-path, and returns the parent directory.

The inverse function is file:children.

An empty sequence is returned if the path points to a root directory.

5.3 file:children

Summary

Returns the paths of all files and directories that are located in the given directory.

Signature

file:children(
$path	as xs:string
) as xs:string*

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns the paths of all files and directories that are located in the given directory. The order of the items in the resulting sequence is not defined. The "." and ".." items are never returned.

The inverse function is file:parent; a related function is file:list.

Error Conditions

[file:no-dir] is raised if $path does not point to an existing directory.

[file:io-error] is raised if any other error occurs.

5.4 file:path-to-native

Summary

Transforms a URI, an absolute path, or relative path to a canonical, system-dependent path representation.

Signature

file:path-to-native(
$path	as xs:string
) as xs:string

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Transforms a URI, an absolute path, or relative path to a canonical, system-dependent path representation. A canonical path is both absolute and unique and thus contains no redirections such as references to parent directories or symbolic links.

If the resulting path points to a directory, it will be suffixed with the system-specific directory separator.

Error Conditions

[file:not-found] is raised if $path does not exist.

[file:io-error] is raised if an error occurs while trying to obtain the native path.

5.5 file:path-to-uri

Summary

Transforms a file system path into a URI.

Signature

file:path-to-uri(
$path	as xs:string
) as xs:anyURI

Properties

This function is deterministic^FO, context-independent^FO, and focus-independent^FO.

Rules

Transforms a file system path into a URI with the file:// scheme. If the path is relative, it is first resolved against the current working directory.

This function is deterministic^FO (no path existence check is made).

5.6 file:resolve-path

Summary

Transforms a relative path into an absolute operating system path.

Signature

file:resolve-path(
$path	as xs:string
) as xs:string

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Transforms a relative path into an absolute operating system path by resolving it against the current working directory.

If the resulting path points to a directory, it will be suffixed with the system-specific directory separator.

6.1 file:dir-separator

Summary

Returns the value of the operating system-specific directory separator.

Signature

file:dir-separator() as xs:string

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns the value of the operating system-specific directory separator, which usually is / on UNIX-based systems and \ on Windows systems.

6.2 file:line-separator

Summary

Returns the value of the operating system-specific line separator.

Signature

file:line-separator() as xs:string

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns the value of the operating system-specific line separator, which usually is 
 on UNIX-based systems, 
 on Windows systems and 
 on Mac systems.

6.3 file:path-separator

Summary

Returns the value of the operating system-specific path separator.

Signature

file:path-separator() as xs:string

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns the value of the operating system-specific path separator, which usually is : on UNIX-based systems and ; on Windows systems.

6.4 file:temp-dir

Summary

Returns the path to the default temporary-file directory of an operating system.

Signature

file:temp-dir() as xs:string

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns the path to the default temporary-file directory of an operating system.

6.5 file:base-dir

Summary

Returns the parent directory of the static base URI.

Signature

file:base-dir() as xs:string?

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns the parent directory of the static base URI.

If the Base URI property is undefined, the empty sequence is returned.

If a static base URI exists, and if points to a local file path, this function returns the same result as the expression file:parent(static-base-uri()).

6.6 file:current-dir

Summary

Returns the current working directory.

Signature

file:current-dir() as xs:string

Properties

This function is nondeterministic^FO, context-dependent^FO, and focus-independent^FO.

Rules

Returns the current working directory.

Formal Equivalent

The effect of the function is equivalent to the result of the following XPath expression.

file:resolve-path('.')