 |
|
|
|
||||
|
|||||
|
|
||||||
| Related Syntax | Other Library Functions | |||||
| function |
vfs.cursor-position |
|
Library: General, File system utilities (OMVFS)
Import: omvfs.xmd |
Return type: Integer Returns: An integer representing the current cursor position. |
export external integer function cursor-position
of value file file-ref
Argument definitions
You can use vfs.cursor-position to get the current position of the cursor in a file represented by a vfs.file object. The byte where the cursor is currently located is returned as an integer.
Find the current cursor position in the open file myscript.xom.
import "omvfs.xmd" prefixed by vfs.
process
local vfs.file data-file
local integer cursor-position
set data-file to vfs.open "/programs/myscript.xom"
; read part of the file
set cursor-position to vfs.cursor-position myFile
Note that vfs.cursor-position returns the position that OmniMark has read up to in the file, not the position that OmniMark has matched up to in a scanned source. Because OmniMark buffers file reads for efficiency, the current file position is not the same as the current scanning position.
The following exceptions may occur:
