vfsCursorPosition

function

Library: File system utilities (OMVFS legacy)
Include: omvfs.xin

Returns: An integer representing the current cursor position.

Declaration

define external integer function vfsCursorPosition
       value  vfsFile  file

Argument definitions

file: is an open vfsFile object.

Purpose

Use vfsCursorPosition to get the current position of the cursor in a vfsFile object. The byte where the cursor is currently located is returned as an integer.

Requirements

You must include the following line at the beginning of your OmniMark program:

  include "omvfs.xin"

file must be opened using vfsOpen (else external exception VFS200).

Usage Notes

External exception VFS300 is thrown for any general OS operation failure. The text accompanying the exception will contain details on the reason for the failure.

Example

Find the current cursor position in the open file myscript.xom.

  include "omvfs.xin"
  
  process
    local vfsFile myFile
    local integer cursorAt
    	.
  	.
  	.
    set myFile to vfsOpen "/programs/myscript.xom"
    	.
  	.
  	.
    set cursorAt to vfsCursorPosition myFile

Other Library Functions