xdmp.externalBinary( $path as String, [$starting-location as Number], [$length as Number] ) as binary()
Returns an external binary node.
|$path||Filesystem path to the external binary file.|
The new binary node starts at the byte position indicated by
|$length||The length in bytes of the content in the new binary node. Omitting the length has performance implications; see usage notes.|
If no length is provided, the length is calculated from the starting
position and the filesystem length of the external file. If the file
does not exist when the length is calculated,
If a length is provided, the length is trusted. That is, no attempt is made to confirm the existence or read the length of the external file. Therefore, including the length in the call (if known) results in the best performance during document creation.
xdmp.externalBinary("/testdata1/logo.gif", 1, 2456); => A binary node representing the external file at /testdata1/logo.gif, beginning at offset 1, with a length of 2456 bytes.