FsRtlFastCheckLockForRead routine

The FsRtlFastCheckLockForRead routine determines whether the specified process has read access to a locked byte range of a file.

Syntax


BOOLEAN FsRtlFastCheckLockForRead(
  _In_ PFILE_LOCK     FileLock,
  _In_ PLARGE_INTEGER StartingByte,
  _In_ PLARGE_INTEGER Length,
  _In_ ULONG          Key,
  _In_ PFILE_OBJECT   FileObject,
  _In_ PVOID          ProcessId
);

Parameters

FileLock [in]

A pointer to the FILE_LOCK structure for the file. This structure must have been initialized by a previous call to FsRtlAllocateFileLock or FsRtlInitializeFileLock.

StartingByte [in]

A pointer to a variable that specifies the starting byte offset within the file of the byte range to check.

Length [in]

A pointer to a variable that specifies the length, in bytes, of the range to check.

Key [in]

The key for the byte range lock.

FileObject [in]

A pointer to the file object for the file.

ProcessId [in]

A pointer to the process ID for the process.

Return value

The FsRtlFastCheckLockForRead routine returns TRUE if the specified process has read access, FALSE otherwise.

Requirements

Target platform

Universal

Version

This routine is available on Microsoft Windows 2000 and later versions of Windows operating systems.

Header

Ntifs.h (include FltKernel.h or Ntifs.h)

Library

NtosKrnl.lib

DLL

NtosKrnl.exe

IRQL

<= APC_LEVEL

See also

FsRtlAllocateFileLock
FsRtlFastCheckLockForWrite
FsRtlInitializeFileLock

 

 

Send comments about this topic to Microsoft

Show: