LockRmsFile

LockRmsFile locks the open RMS file for exclusive use.  If other processes are using the RMS file, the function fails and returns immediately.

Syntax

Function LockRmsFile(rmsHandle as Integer) As Boolean

Parameters

No parameter

Return Values

On success, LockRmsFile returns TRUE.  If failed, it returns FALSE.

Remarks

The function LockRmsFile locks the open RMS file for exclusive use.  If other processes are

using the RMS file, the function fails and returns immediately.  If you do not want to return

immediately while the file is busy, call LockRmsFileWait.

See Also

LockRmsFileWait, UnLockRmsFile, LockRmsFile.