Changes

All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/proc</nowiki></code> namespace, which is statically bound to the <code>{{Code|proc</code> }} prefix.<br/>All errors are assigned to the <code>http://basex.org/errors</code> namespace, which is statically bound to the <code>bxerr</code> prefix.

 {|width='100%'|-valign="top"| width='90120' | '''SignaturesSignature'''|{{Mono|<bpre>proc:system</b>( $cmd as xs:string) as xs:string}}<br/>{{Mono|<b>proc:system</b>($cmd command as xs:string, $args arguments as xs:string*) as xs :string}}<br/>{{Mono|<b>proc:system</b>= ($cmd as xs:string), $args options as xs:stringmap(*, $encoding as xs)? :string= map { }) as xs:string}}</pre>|-valign="top"

|Executes a {{Code|$command}} with the specified command {{Code|$arguments}} in a separate process and returns the result as a string.<br/>If the command results in an error, an XQuery exception will be thrown. Its error code will consist of the letters The {{MonoCode|PROC$options}} and four digits with the command’s exit code.<br/>Additional command arguments may be specified via parameter contains process options:* {{MonoCode|$argsencoding}}.<br/>The : convert result can be explicitly converted to a the specified {{Mono|$encoding}}. If no encoding is specifiedsupplied, the system’s default encoding is used.* {{Code|timeout}}: abort process execution after the specified number of seconds.* {{Code|dir}}: process command in the specified directory.* {{Code|input}}: standard string input ({{Code|stdin}}) to be passed on to the command.|-valign="top"

|'''[[{{Error|encoding|#Errors|BXPR9999]]''' is raised if Error}} the specified encoding does not exist or is not supported.<br/>{{Error|timeout|#Error}} the specified timeout was exceeded.<br/>{{Error|error|#Error}} the command could not be executed, or an I/O exception was raised.<br/>{{Error|code....|#Error}} If the commands returns an exit code different to 0, an error will be raised. Its code will consist of the letters {{Code|code}} and four digits with the exit code.<br/>|-valign="top"

* {{MonoCode|proc:system('date')}} returns the current date on a Linux system.* Analyses the given input and counts the number of lines, words and characters (provided that {{Code|wc}} is available on the system):<pre lang='xquery'>proc:system( 'wc', (), map { 'input': 'A B' || out:nl() || 'C' })</pre>* The following example returns "Command “Command not found", if found” (unless {{Code|xyz}} is a valid command on the command "xyz" cannot be located or executedsystem):<pre classlang="brush:'xquery"'>

} catch bxerrproc:BXPR0002 error { 'Command not found.: '|| $err:description

 {|width='100%'|-valign="top"| width='90120' | '''SignaturesSignature'''|{{Mono|<bpre>proc:execute</b>($cmd as xs:string) as element(result)}}<br/>{{Mono|<b>proc:execute</b>( $cmd command as xs:string, $args arguments as xs:string*) as element := (result)}}<br/>{{Mono|<b>proc:execute</b>($cmd as xs:string, $args options as xs:stringmap(*, $encoding as xs)? :string= map { }) as element(result)}}</pre>|-valign="top"

|Executes a {{Code|$command}} with the specified command {{Code|$arguments}} in a separate process and returns the result as an element.<br/>Additional command arguments may be specified via :* The same {{MonoCode|$argsoptions}} are allowed as for {{Function||proc:system}}.<br/>The result can * Instead of the {{Code|proc:error}} error, the error message and process code will be explicitly converted assigned to a specified the returned elements.* Instead of the {{MonoCode|$encodingproc:code....}}. If no encoding is specifiederror, the system’s default encoding is usederror message will be assigned to the returned element (no process code will be returned).<br/>A The result has the following structure:<br/><pre classlang="brush:xml">

<output>...resultoutput...</output> <error>...error message...</error> <code>0...process code...</code>

|-valign="top"

|{{Error|encoding|#Error}} the specified encoding does not exist or is not supported.<br/>{{Error|timeout|#Error}} the specified timeout was exceeded.|- valign="top"| '''Examples'''|* {{Code|proc:execute('dir', '\')}} returns the files of the root directory of a Windows system.* {{Code|proc:execute('ls', ('-l', '-a'))}} executes the {{Code|ls -la}} command on Unix systems.|} ==proc:fork== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>proc:fork( $command as xs:string, $arguments as xs:string* := (), $options as map(*)? := map { }) as element(result)</pre>|- valign="top"| '''Summary'''|Executes a {{Code|$command}} with the specified {{Code|$arguments}} in a separate process and ignores the result. The same {{Code|$options}} are allowed as for {{Function||proc:system}} with the encoding being ignored.|- valign="top"|'''[[#Errors|BXPR9999]]''' is raised if |{{Error|encoding|#Error}} the specified encoding does not exist or is not supported.|-valign="top"| '''Examples'''|* {{Code|proc:fork('sleep', '5')}}: sleep for 5 seconds (no one should notice).|} ==proc:property== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>proc:property( $name as xs:string) as xs:string?</pre>|- valign="top"| '''Summary'''|Returns the system property, specified by {{Code|$name}}, or a context parameter of the {{Code|web.xml}} file with that name (see [[Web_Application#Configuration|Web Applications]]). An empty sequence is returned if the property does not exist. For environment variables of the operating system, please use [https://www.w3.org/TR/xpath-functions-30/#func-environment-variable fn:environment-variable]. |- valign="top"

* {{MonoCode|proc:executeproperty('dirjava.class.path')}} returns the full user class path.* {{Code|map:merge(proc:property-names() ! map:entry(., '\'proc:property(.)))}} returns the root directory on a Windows map with all systemproperties.

=Changelog=proc:property-names==

The module was introduced with {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>proc:property-names() as xs:string*</pre>|- valign="top"| '''Summary'''|Returns the names of all Java system properties and context parameters of the {Version{Code|web.xml}} file (see [[Web_Application#Configuration|7Web Applications]]).2For environment variables of the operating system, please use [https://www.2w3.org/TR/xpath-functions-30/#func-available-environment-variables fn:available-environment-variables]. |- valign="top"| '''Examples'''|* {{Code|proc:property('java.runtime.version')}}returns the version of the Java runtime engine.|}

! width="5%110"|Code! width|Description|- valign="top"|{{Code|code...}}|The result of a command call with an exit code different to 0.|- valign="95%top"|{{Code|code9999}}|DescriptionA command could not be executed.|-valign="top"|<code>BXPR9999</code>{{Code|encoding}}