Edit

CcSetLogHandleForFile function (ntifs.h)

  • Article

The CcSetLogHandleForFile routine sets a log handle for a file.

Syntax

void CcSetLogHandleForFile(
  [in] PFILE_OBJECT  FileObject,
  [in] PVOID         LogHandle,
  [in] PFLUSH_TO_LSN FlushToLsnRoutine
);

Parameters

[in] FileObject

Pointer to the file object for the file for which the log handle is to be stored.

[in] LogHandle

Pointer to the log handle that is to be stored.

[in] FlushToLsnRoutine

Pointer to a log file flush callback routine to call before flushing buffers for this file. This routine is called to ensure that a log file is flushed to the most recent logical sequence number (LSN) for any buffer control block (BCB) being flushed. This routine is declared as follows:

typedef
VOID (*PFLUSH_TO_LSN) (
            IN PVOID LogHandle,
            IN LARGE_INTEGER Lsn
            );

LogHandle

Pointer to an opaque structure that is used to identify this client.

Lsn

This is the LSN that must be on the disk on return from this callback routine.

Return value

None

Remarks

CcSetLogHandleForFile sets a log handle for a file, for use in subsequent calls to CcGetDirtyPages.

Requirements

Requirement Value
Minimum supported client Windows XP
Target Platform Universal
Header ntifs.h (include Ntifs.h)
Library NtosKrnl.lib
DLL NtosKrnl.exe
IRQL Any level

See also

CcGetDirtyPages

CcSetDirtyPinnedData