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

Declaration

export external function unlock
                value file file-ref
        id      value integer lock-id optional

Argument definitions

file-ref

The vfs.file object associated with the file to be unlocked.

lock-id

The identifier returned by vfs.lock.

You can use vfs.unlock to unlock a file or a section of a file that was locked using vfs.lock.

This program shows a lock being set and then removed.

    import "omvfs.xmd" prefixed by vfs.
  
    process
       local vfs.file test-file
       local integer test-lock
       set test-file to vfs.open "test.txt"
       vfs.lock test-file
        from vfs.start-offset to 800
        id test-lock
  
        ;process the file
  
       vfs.unlock test-file
       id test-lock

If you have locked multiple sections of a file, you can use the lock identifier to specify the section to unlock. If the lock identifier is not specified, all the locks on the file will be released.

Exceptions

The following exceptions may occur:

• VFS200 The vfsFile object must be opened before it can be used
• VFS218 An invalid lock ID was specified
• VFS300 Generic operating system error

Related Syntax    vfs.open    vfs.lock    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

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