PxIOFileLock

Description

Locks the specified file

Format

int PxIOFileLock(PxIOFileHandle handle);

Where:

handle

The handle of an open file

Return Value

If the function succeeds, a value of PXIO_SUCCESS_STATUS is returned; otherwise, an error value is returned. More information on the nature of the error can be found by calling PxIOGetError.

Note:
If another process has already the file locked, an error is returned immediately.