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

vfsCursorPosition

 
 

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

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
   vfsChangeDir
   vfsChangeOwner
   vfsChangePermissions
   vfsClose
   vfsConnect
   vfsConnectDir
   vfsCopy
   vfsCursorPosition
   vfsDeleteDir
   vfsDeleteFile
   vfsDescribe
   vfsDescribeFile
   vfsDir
   vfsDirName
   vfsDisconnect
   vfsFile
   vfsFileDir
   vfsFileName
   vfsIsVersionCompatible
   vfsLibraryVersion
   vfsLink
   vfsList
   vfsLock
   vfsMakeDir
   vfsMove
   vfsMoveCursor
   vfsOpen
   vfsRead
   vfsRename
   vfsTruncate
   vfsUnlock
   vfsWrite
 
 

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.