Difference between revisions of "Process Module"
Jump to navigation
Jump to search
m (moved Proc Module to Process Module) |
|||
Line 7: | Line 7: | ||
|- | |- | ||
| valign='top' width='90' | '''Signatures''' | | valign='top' width='90' | '''Signatures''' | ||
− | |{{Mono|<b>proc:system</b>($cmd as xs:string) as xs:string}}<br/>{{Mono|<b>proc:system</b>($cmd as xs:string, $args as xs:string*) as xs:string}} | + | |{{Mono|<b>proc:system</b>($cmd as xs:string) as xs:string}}<br/>{{Mono|<b>proc:system</b>($cmd as xs:string, $args as xs:string*) as xs:string}}<br/>{{Mono|<b>proc:system</b>($cmd as xs:string, $args as xs:string*, $encoding as xs:string) as xs:string}} |
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Executes the specified command in a separate process and returns the result as string.<br/>If the command results in an error, an XQuery exception will be thrown. Its error code will consist of the letters {{Mono|PROC}} and four digits with the command’s exit code.<br/>Additional command arguments may be specified via {{Mono|$args}}. | + | |Executes the specified command in a separate process and returns the result as string.<br/>If the command results in an error, an XQuery exception will be thrown. Its error code will consist of the letters {{Mono|PROC}} and four digits with the command’s exit code.<br/>Additional command arguments may be specified via {{Mono|$args}}.<br/>The result can be explicitly converted to the specified {{Mono|$encoding}}. If no encoding is specified, the system’s default encoding is used. |
|- | |- | ||
| valign='top' | '''Examples''' | | valign='top' | '''Examples''' | ||
Line 29: | Line 29: | ||
|- | |- | ||
| valign='top' width='90' | '''Signatures''' | | valign='top' width='90' | '''Signatures''' | ||
− | |{{Mono|<b>proc:execute</b>($cmd as xs:string) as element(result)}}<br/>{{Mono|<b>proc:execute</b>($cmd as xs:string, $args as xs:string*) as element(result)}} | + | |{{Mono|<b>proc:execute</b>($cmd as xs:string) as element(result)}}<br/>{{Mono|<b>proc:execute</b>($cmd as xs:string, $args as xs:string*) as element(result)}}<br/>{{Mono|<b>proc:execute</b>($cmd as xs:string, $args as xs:string*, $encoding as xs:string) as element(result)}} |
|- | |- | ||
| valign='top' | '''Summary''' | | valign='top' | '''Summary''' | ||
− | |Executes the specified command in a separate process and returns the result as element.<br/>Additional command arguments may be specified via {{Mono|$args}}.<br/>A result has the following structure:<br/> | + | |Executes the specified command in a separate process and returns the result as element.<br/>Additional command arguments may be specified via {{Mono|$args}}.<br/>The result can be explicitly converted to the specified {{Mono|$encoding}}. If no encoding is specified, the system’s default encoding is used.<br/>A result has the following structure:<br/> |
<pre class="brush:xml"> | <pre class="brush:xml"> | ||
<result> | <result> |
Revision as of 16:34, 15 May 2012
This XQuery Module provides functions for executing system commands from XQuery. All functions are introduced with the proc:
prefix, which is linked to the statically declared http://basex.org/modules/proc
namespace.
Functions
proc:system
Signatures | proc:system($cmd as xs:string) as xs:string proc:system($cmd as xs:string, $args as xs:string*) as xs:string proc:system($cmd as xs:string, $args as xs:string*, $encoding as xs:string) as xs:string
|
Summary | Executes the specified command in a separate process and returns the result as string. If the command results in an error, an XQuery exception will be thrown. Its error code will consist of the letters PROC and four digits with the command’s exit code.Additional command arguments may be specified via $args .The result can be explicitly converted to the specified $encoding . If no encoding is specified, the system’s default encoding is used.
|
Examples |
try { proc:system('xyz') } catch PROC0001 { 'Command not found.' } |
proc:execute
Signatures | proc:execute($cmd as xs:string) as element(result) proc:execute($cmd as xs:string, $args as xs:string*) as element(result) proc:execute($cmd as xs:string, $args as xs:string*, $encoding as xs:string) as element(result)
|
Summary | Executes the specified command in a separate process and returns the result as element. Additional command arguments may be specified via $args .The result can be explicitly converted to the specified $encoding . If no encoding is specified, the system’s default encoding is used.A result has the following structure: <result> <output>...result...</output> <error/> <code>0</code> </result> |
Examples |
|
Changelog
The module was introduced with Version 7.2.2.