FsRtlGetPerFileContextPointer macro

The FsRtlGetPerFileContextPointer macro returns a FileContextSupportPointer for an open file.

Syntax

PVOID FsRtlGetPerFileContextPointer(
   FILE_OBJECT FileObject
);

Parameters

  • FileObject
    A pointer to a file object.

Return value

The FsRtlGetPerFileContextPointer macro returns an opaque pointer used by the file system runtime library (FSRTL) package to track file contexts. The macro returns NULL if the file system does not support the use of per-file context objects with files.

Remarks

The FsRtlGetPerFileContextPointer macro returns the pointer to be passed to routines such as FsRtlInsertPerFileContext,FsRtlLookupPerFileContext, and FsRtlRemovePerFileContext.

For more information about how to use and create context objects, see Tracking Per-File Context in a Legacy File System Filter Driver.

Requirements

Target platform

Desktop

Version

Available starting with Windows Vista.

Header

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

IRQL

Any

See also

File System Support for Contexts

FSRTL_ADVANCED_FCB_HEADER

FsRtlSetupAdvancedHeaderEx

 

 

Send comments about this topic to Microsoft