Difference between revisions of "Process Module"
Jump to navigation
Jump to search
m (Text replace - "{|" to "{| width='100%'") |
|||
Line 9: | Line 9: | ||
==proc:system== | ==proc:system== | ||
− | {| | + | {| width='100%' |
|- | |- | ||
| width='90' | '''Signatures''' | | width='90' | '''Signatures''' | ||
Line 34: | Line 34: | ||
==proc:execute== | ==proc:execute== | ||
− | {| | + | {| width='100%' |
|- | |- | ||
| width='90' | '''Signatures''' | | width='90' | '''Signatures''' | ||
Line 59: | Line 59: | ||
=Errors= | =Errors= | ||
− | {| class="wikitable" width="100%" | + | {| width='100%' class="wikitable" width="100%" |
! width="5%"|Code | ! width="5%"|Code | ||
! width="95%"|Description | ! width="95%"|Description |
Revision as of 14:23, 21 December 2012
This XQuery Module provides functions for executing system commands from XQuery.
Conventions
All functions in this module are assigned to the http://basex.org/modules/proc
namespace, which is statically bound to the proc
prefix.
All errors are assigned to the http://basex.org/errors
namespace, which is statically bound to the bxerr
prefix.
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. Additional command arguments may be specified via $args .The result can be explicitly converted to a specified $encoding . If no encoding is specified, the system’s default encoding is used.
|
Errors | BXPRnnnn : If the command results in an error, an XQuery error will be raised. Its code will consist of the letters BXPR and four digits with the command’s exit code.BXPR9999 : the specified encoding does not exist or is not supported.
|
Examples |
try { proc:system('xyz') } catch bxerr:BXPR0002 { '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 a 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}} </result> |
Errors | BXPR9999 : the specified encoding does not exist or is not supported.
|
Examples |
|
Errors
Code | Description |
---|---|
BXPR9999
|
The specified encoding does not exist or is not supported. |
Changelog
The module was introduced with Version 7.3.