[SparForte][Banner]
[Top Main Menu] Intro | Tutorials | Reference | Packages | Examples | Contributors   [Back Page]      [Next Page]  

Lock_Files Package

A lock file is a file that, if it exists, indicates that a particular resource is in use. The lock_files package contains procedures to create and destroy lock files under any operating system. If a lock file cannot be locked, an error is reported.

GCC Ada Equivalent: GNAT.Lock_Files
 

lock_files.lock_file( [dir,] file, [, wait [, retries] ] )

create a lock file named file in optional directory dir.  Retry up to retries (natural) times, waiting for wait (duration) seconds between retries. Default for wait/retries in 1.0 second and almost forever.
Example: lock_files.lock_file( "test_lock.lck" );
Ada Equivalent: GNAT.Lock_Files.Lock_File
Parameters:
dir in string "." the directory to place the lock file in
file in string required the name of the lock file
wait in duration 1.0 the number of seconds to wait between retries
retries in natural largest natural the maximum number of retries

If the file cannot be locked, SparForte reports an error.

lock_files.unlock_file( [dir,] file )

delete the lock file name file in optional directory dir.
Example: lock_files.unlock_file( "test_lock.lck" );
Ada Equivalent: GNAT.Lock_Files.Unlock_File
Parameters:
dir in string "." the directory the lock file is in
file in string required the name of the lock file
 
 [Right Submenu]

 Summary

 arrays

 calendar

 cgi

 command_line

 db/ postgresql

 directory_operations

 enums

 files

 lock_files

 mysql

 numerics

 os

 pen

 sound

 source_info

 stats

 strings

 System

 text_io

 units
[Back to Top] Back To Top [Small Forte Symbol]