|
file.extract-text
|
| |
|
description
Extract texts from the given file. This command is generally used
to index content of the file in the internal searchengine.
privilege-required
anyone
tx-support
false
|
| |
|
INSTRUCTION
|
|
name
|
type
|
default-value
|
required
|
description
|
| source-uri |
string |
none |
true |
URI of the source file. |
| filetype |
string |
none |
false |
Specify the type of the file. Known type are pdf.
If no type is given, the command try to guess the type using file extension. |
| password |
string |
none |
false |
Password to read the file (when its password protected, such as pdf files). |
|
| |
|
ERROR
|
|
|
id
|
msg
|
| 1 |
File does not exist |
| 2 |
Unknown file type |
|
| |
|
RESULT
|
|
|
name
|
description
|
| extracted-text |
Extracted text content of source file. |
|
| |
|
EXAMPLE
|
|
|
example 1
|
Extract text from a PDF file
<nvd:command name="file.extract-text" source-uri="/source/file.pdf">
<nvd:result name="extracted-text" variable="text-variable" />
</nvd:command>
|
|
