Files
harbour-core/doc/en/hbflock.txt
Viktor Szakats 03ac58b17b 2017-09-08 18:22 UTC Viktor Szakats (vszakats users.noreply.github.com)
* bin/commit.hb
  * config/detect.mk
  * config/detfun.mk
  * config/detplat.mk
  * config/dir.mk
  * config/dirsh.mk
  * config/global.mk
  * config/globsh.mk
  * config/instsh.mk
  * config/lang.hb
  * config/lang2po.hb
  * config/po2lang.hb
  * config/postinst.hb
  * contrib/hbexpat/tests/tohash.prg
  * contrib/hbformat/utils/hbformat.ini
  * contrib/hbmisc/hbedit.prg
  * contrib/hbmxml/tests/testmxml.prg
  * contrib/hbnetio/utils/hbnetio/_console.prg
  * contrib/hbnetio/utils/hbnetio/_winsvc.prg
  * contrib/hbnetio/utils/hbnetio/hbnetio.prg
  * contrib/hbnetio/utils/hbnetio/netiomgm.hb
  * contrib/hbwin/tests/ole.prg
  * contrib/hbwin/tests/oletst2.js
  * contrib/hbwin/tests/oletst2.vbs
  * contrib/hbxpp/doc/en/binnumx.txt
  * contrib/hbxpp/doc/en/dbcmdx.txt
  * contrib/xhb/htmutil.prg
  * contrib/xhb/tfile.prg
  * contrib/xhb/tframe.prg
  * contrib/xhb/thtm.prg
  * ChangeLog.txt
  * debian/copyright
  * doc/class_tp.txt
  * doc/hdr_tpl.txt
  * doc/xhb-diff.txt
  * LICENSE.txt
  * package/harbour-wce.spec.in
  * package/harbour-win.spec.in
  * package/harbour.spec
  * package/mpkg_rpm_wce.sh
  * package/mpkg_rpm_win.sh
  * package/mpkg_rpm.sh
  * package/mpkg_src.sh
  * package/mpkg_ver.sh
  * src/rtl/achoice.prg
  * src/rtl/getsys53.prg
  * src/rtl/tgetlist.prg
  * src/rtl/tlabel.prg
  * src/rtl/tmenusys.prg
  * tests/hbdoc.prg
  * tests/langmsg.prg
  * tests/rto_get.prg
  * tests/rto_tb.prg
  + doc/en/ati.txt
  + doc/en/dirdrive.txt
  + doc/en/hashfunc.txt
  + doc/en/hbtoken.txt
  + doc/en/left.txt
  + doc/en/proc.txt
  + doc/en/strtran.txt
  + doc/en/transfrm.txt
  + doc/en/typefile.txt
  * doc/en/*
    * more partial sync with 3.4 fork
2017-09-08 18:25:11 +00:00

108 lines
3.0 KiB
Plaintext

/* $DOC$
$TEMPLATE$
Function
$NAME$
hb_FLock()
$CATEGORY$
API
$SUBCATEGORY$
FileSys
$ONELINER$
Locks part or all of any file
$SYNTAX$
hb_FLock( <nHandle>, <nOffset>, <nBytes> [, <nType ] )
--> lSuccess
$ARGUMENTS$
<nHandle> OS file handle
set> Offset of the first byte of the region to be locked.
<nBytes> Number of bytes to be locked.
e> The type (read or write) of lock requested.
$RETURNS$
<lSuccess> .T. if the lock was obtained, else .F.
$DESCRIPTION$
This function attempts to lock a region of the file whose file handle
is <nHandle>. This is a low-level file function. To lock Harbour
data files use either the FLock() or RLock() function.
The value of <nHandle> is obtained from either a call to the FOpen()
or the FCreate() function.
<nOffset> is the offset (from the beginning of the file) to the first
of the region to be locked. (Offsets from the current position
nd of file are not currently supported.)
<nBytes> is the length of the region to be locked in bytes.
<nType> is the type of lock requested. There are two types of locks:
exclusive write locks ( <nType> = 0x0000 ) - the default, and shared
read locks ( <nType> = 0x0100 ). Additionally you can specify a
blocking version of this function (that is it won't return until
either an error has occurred or the lock has been obtained) by
adding 0x0200 to the above values.
$EXAMPLES$
// refer to tests/tflock.prg
$STATUS$
R
$COMPLIANCE$
H
$PLATFORMS$
All
$FILES$
Library is core
$SEEALSO$
hb_FUnlock(), FOpen(), FCreate(), FError(), FClose()
$END$
*/
/* $DOC$
$TEMPLATE$
Function
$NAME$
hb_FUnlock()
$CATEGORY$
API
$SUBCATEGORY$
FileSys
$ONELINER$
Unlocks part or all of any file
$SYNTAX$
hb_FUnlock( <nHandle>, <nOffset>, <nBytes> ) --> lSuccess
$ARGUMENTS$
<nHandle> OS file handle
set> Offset of the first byte of the region to be locked.
<nBytes> Number of bytes to be locked.
$RETURNS$
<lSuccess> .T. if the lock was removed, else .F.
$DESCRIPTION$
This function attempts to unlock a region of the file whose file
handle is <nHandle>. This is a low-level file function. To
unlock Harbour data files use the dbUnlock() function.
The value of <nHandle> is obtained from either a call to the FOpen()
or the FCreate() function.
<nOffset> is the offset (from the beginning of the file) to the first
of the region to be unlocked. (Offsets from the current position
nd of file are not currently supported.)
<nBytes> is the length of the region to be unlocked in bytes.
$EXAMPLES$
// refer to tests/tflock.prg
$STATUS$
R
$COMPLIANCE$
H
$PLATFORMS$
All
$FILES$
Library is core
$SEEALSO$
hb_FLock(), FOpen(), FCreate(), FError(), FClose()
$END$
*/