Name
p:file-delete — The standard p:file-delete step.
Synopsis
The p:file-delete step deletes a file or a directory.
| Output port | Primary | Sequence | Content types |
|---|---|---|---|
| result | ✔ | application/xml |
| Option name | Type | Default value | Required |
|---|---|---|---|
| href | xs:anyURI | ✔ | |
| fail-on-error | xs:boolean | true() | |
| recursive | xs:boolean | false() |
Declaration
1 |<p:declare-step xmlns:p="http://www.w3.org/ns/xproc">
| <p:output port="result" primary="true" content-types="application/xml"/>
| <p:option name="href" required="true" as="xs:anyURI"/>
| <p:option name="recursive" as="xs:boolean" select="false()"/>
5 | <p:option name="fail-on-error" as="xs:boolean" select="true()"/>
|</p:declare-step>Errors
| Code | Description |
|---|---|
err:XC0113 | It is a dynamic error (err:XC0113) if an attempt is made to delete a non-empty
directory and the recursive option was set to false. |
err:XC0142 | It is a dynamic error (err:XC0142) if an
implementation does not support p:file-delete for a specified scheme. |
err:XC0143 | It is a
dynamic error (err:XC0143) if p:file-delete is not available to the step due to access restrictions
in the environment in which the pipeline is run. |
err:XD0011 | It is a dynamic error (err:XD0011) if the resource referenced by the
href option cannot be accessed or is not a file or directory. |
err:XD0064 | It is a dynamic
error (err:XD0064) if the base URI is not both absolute and valid according to RFC 3986. |
Implementation defined features
- Conformant processors must support URIs whose
scheme is
filefor thehrefoption ofp:file-delete. It is implementation-defined what other schemes are supported byp:file-delete, and what the interpretation of ‘directory’, ‘file’ and ‘contents’ is for those schemes.
Description
The p:file-delete step is defined in the
XProc 3.1:
Standard Step Library. It is also described on
XProcRef.org.