swirl
Guide to OmniMark 8   OmniMark home
docs home 
IndexConceptsTasksSyntaxLibrariesLegacy LibrariesErrors
 
  Related Syntax     Other Library Functions  
function  

vfs.cursor-position

 
 

Library: File system utilities (OMVFS)
Import: omvfs.xmd
Return type: Integer

Returns: An integer representing the current cursor position.


Declaration

export external integer function cursor-position
        of      value file file-ref

Argument definitions

file
An open VFS file object.


Purpose

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.

Example

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.

Exceptions

The following exceptions may occur:

    Related Syntax
   vfs.move-cursor
   vfs.reader
   vfs.file
 
  Other Library Functions
   vfs.change-directory
   vfs.change-owner
   vfs.change-permissions
   vfs.close
   vfs.connect
   vfs.connect-directory
   vfs.copy
   vfs.cursor-position
   vfs.default-certificates-file
   vfs.delete-directory
   vfs.delete-file
   vfs.describe
   vfs.describe-file
   vfs.directory
   vfs.directory-name
   vfs.disconnect
   vfs.file
   vfs.file-directory
   vfs.file-name
   vfs.link
   vfs.list
   vfs.lock
   vfs.make-directory
   vfs.move
   vfs.move-cursor
   vfs.omvfs-version
   vfs.open
   vfs.open-file-system
   vfs.open-ftp
   vfs.open-http
   vfs.open-https
   vfs.reader
   vfs.set-default-certificates-file
   vfs.truncate
   vfs.unlock
   vfs.writer
 
 

Top [ INDEX ] [ CONCEPTS ] [ TASKS ] [ SYNTAX ] [ LIBRARIES ] [ LEGACY LIBRARIES ] [ ERRORS ]

OmniMark 8.2.0 Documentation Generated: March 13, 2008 at 3:27:39 pm
If you have any comments about this section of the documentation, please use this form.

Copyright © Stilo International plc, 1988-2008.