company logo

File :: lock - Lock file positions

When locking file positions succeeded, the function returns true . The function returns false , when an error occurs while locking the file (file not opened, position already locked).

Return value:  Success ( bool  )

The value is true when the function was executed successfully. Otherwise the value is set to false .

Implementation details

bool File  :: lock ( int64 iPosition64, int32 iLenght, bool bWait )

The function locks iLength bytes at file position iPosition64 . The file must have been opened and the requested area must not contain locked positions. File positions must exist virtually, only. When passing true in bWait , the function tries locking the file positione up-to 10 seconds and terminates when succeeding or fails after 10 seconds.

  • iPosition64 - Position in an area or file

    The big position value usually refers to a relative position in an area or file.

  • iLenght - - internal feature (not documented)
  • bWait - Wait option

    When true is passed, the submitting process or thread is forced to wait un til the submitted process or thread has finished.