Share via

FSDMGR_TestFileLockEx (Compact 2013)

  • Article

3/26/2014

This function authorizes read or write requests.

Syntax

BOOL FSDMGR_TestFileLockEx(
  PACQUIREFILELOCKSTATE pAcquireFileLockState,
  PRELEASEFILELOCKSTATE pReleaseFileLockState,
  DWORD dwHandle,
  BOOL fRead,
  DWORD cbReadWrite,
  DWORD dwOffsetLow,
  DWORD dwOffsetHigh
);

Parameters

  • dwHandle
    Handle to the specified file.
  • fRead
    Specifies whether the file can be read.
  • cbReadWrite
    Specifies whether the file can be read and written to.
  • dwOffsetLow
    Low DWORD file offset for the handle when the file lock is installed.
  • dwOffsetHigh
    High DWORD file offset for the handle when the file lock is installed.

Return Value

Nonzero indicates success. Zero indicates failure. To get extended error information, call GetLastError.

Remarks

The FSD can simply pass all parameters received by MyFSD_LockFileEx to this helper function, along with two helper function pointers, PACQUIREFILELOCKSTATE and PRELEASEFILELOCKSTATE, implemented by the FSD.

This function is a Lock Manager function provided by FSDMGR to assist FSDs with implementing the MyFSD_LockFileEx and the MyFSD_UnLockFileEx functions.

Requirements

Header

lockmgr.h

Library

Fsdmgr.lib

See Also

Reference

FSDMGR Functions
FSDMGR_TestFileLock
FSDMGR_RemoveFileLock
FSDMGR_RemoveFileLockEx
FSDMGR_AcquireFileLock