company logo

File :: locked - Is file area locked

The function returns true, when the file area contains locked positions and false otherwise. In case of an error (file not opened), the function returns false.

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  :: locked ( int64 iPosition64, int32 iLenght )

The function checks, whether any position between iPosition64 andiPosition64+iLength is locked. File positions must exist virtually, only.

  • 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)