FltGetFileContext function (fltkernel.h)

The FltGetFileContext routine retrieves a context that was set for a file by a given minifilter driver instance.

Syntax

NTSTATUS FLTAPI FltGetFileContext(
  [in]  PFLT_INSTANCE Instance,
  [in]  PFILE_OBJECT  FileObject,
  [out] PFLT_CONTEXT  *Context
);

Parameters

[in] Instance

Opaque instance pointer for the caller. This parameter is required and cannot be NULL.

[in] FileObject

File object pointer for the file. This parameter is required and cannot be NULL.

[out] Context

Pointer to a caller-allocated variable that receives the address of the context. This parameter is required and cannot be set to NULL.

Return value

FltGetFileContext returns STATUS_SUCCESS when it successfully returns the requested file context. Otherwise, it returns an appropriate NTSTATUS value such as one of the following:

Remarks

For more information about contexts, see About minifilter contexts.

A minifilter driver calls FltGetFileContext to retrieve the file context that it has set for a given file.

FltGetFileContext increments the reference count on the context that the Context parameter points to. When this context pointer is no longer needed, the caller must decrement its reference count by calling FltReleaseContext. Thus, every successful call to FltGetFileContext must be matched by a subsequent call to FltReleaseContext.

To set a file context, call FltSetFileContext.

To allocate a new context, call FltAllocateContext.

To delete a file context, call FltDeleteFileContext or FltDeleteContext.

To determine whether file contexts are supported for a given file, call FltSupportsFileContexts or FltSupportsFileContextsEx.

Requirements

See also

FLT_CONTEXT_REGISTRATION

FltAllocateContext

FltDeleteContext

FltDeleteFileContext

FltReleaseContext

FltSetFileContext

FltSupportsFileContexts

FltSupportsFileContextsEx