FltSetStreamHandleContext function (fltkernel.h)

Article
10/21/2021

The FltSetStreamHandleContext routine sets a context for a stream handle.

Syntax

NTSTATUS FLTAPI FltSetStreamHandleContext(
  [in]            PFLT_INSTANCE             Instance,
  [in]            PFILE_OBJECT              FileObject,
  [in]            FLT_SET_CONTEXT_OPERATION Operation,
  [in]            PFLT_CONTEXT              NewContext,
  [out, optional] PFLT_CONTEXT              *OldContext
);

Parameters

[in] Instance

An opaque instance pointer for the minifilter driver instance whose context is to be inserted into, removed from, or replaced in the list of contexts attached to the stream handle.

[in] FileObject

A pointer to a file object for the file stream. This parameter is required and cannot be NULL.

[in] Operation

A flag that specifies details of the operation to be performed. This parameter must be one of the following:

Value	Meaning
FLT_SET_CONTEXT_REPLACE_IF_EXISTS	If a context is already set for this Instance, FltSetStreamHandleContext will replace it with the context specified in NewContext. Otherwise, it will insert NewContext into the list of contexts for the stream handle.
FLT_SET_CONTEXT_KEEP_IF_EXISTS	If a context is already set for this Instance, FltSetStreamHandleContext will return STATUS_FLT_CONTEXT_ALREADY_DEFINED, and will not replace the existing context or increment the reference count. If a context has not already been set, the routine will insert NewContext into the list of contexts for the stream handle and increment the reference count.

[in] NewContext

A pointer to the new context to be set for the stream handle. This parameter is required and cannot be NULL.

[out, optional] OldContext

A pointer to a caller-allocated variable that receives the address of the existing stream handle context for the Instance parameter, if one is already set. This parameter is optional and can be NULL. For more information about this parameter, see the following Remarks section.

Return value

The FltSetStreamHandleContext routine returns STATUS_SUCCESS or an appropriate NTSTATUS value such as one of the following error codes:

Return code	Description
STATUS_FLT_CONTEXT_ALREADY_DEFINED	If FLT_SET_CONTEXT_KEEP_IF_EXISTS was specified for Operation, this error code indicates that a context is already attached to the stream handle.
STATUS_FLT_CONTEXT_ALREADY_LINKED	The context that NewContext points to is already linked to an object. In other words, this error code indicates that NewContext is already in use due to a successful prior call of a FltSetXxxContext routine.
STATUS_FLT_DELETING_OBJECT	The specified Instance is being torn down. This is an error code.
STATUS_INVALID_PARAMETER	An invalid parameter was passed. For example, the NewContext parameter does not point to a valid stream handle context, or an invalid value was specified for Operation.
STATUS_NOT_SUPPORTED	An unsupported situation occurred, such as the file system does not support per-stream contexts for this file stream, or the caller provided a NULL FileObject.

Remarks

For more information about contexts, see About minifilter contexts.

The FltSetStreamHandleContext routine adds, removes, or replaces a context for a minifilter driver instance on a stream handle. A minifilter driver can attach one context per minifilter driver instance to the stream handle.

FltSetStreamHandleContext cannot be called on an unopened FileObject. Hence FltSetStreamHandleContext cannot be called from a pre-create callback for a stream because the stream has not been opened at that point. A minifilter can, however, allocate and set up the stream handle context in the pre-create callback, pass it to the post-create callback using the completion context parameter and set the stream handle context on the stream in the post-create callback.

Reference Counting

If FltSetStreamHandleContext succeeds:

The reference count on NewContext is incremented. When NewContext is no longer needed, the minifilter must call FltReleaseContext to decrement its reference count.

Else if FltSetStreamHandleContext fails:

The reference count on NewContext remains unchanged.
If OldContext is not NULL and does not point to NULL_CONTEXT then OldContext is a referenced pointer to the context currently associated with the stream handle. The filter calling FltSetStreamHandleContext must call FltReleaseContext for OldContext as well when the context pointer is no longer needed.

Regardless of success:

The filter calling FltSetStreamHandleContext must call FltReleaseContext to decrement the reference count on the NewContext object that was incremented by FltAllocateContext.

For more information, see Referencing Contexts.

Other context operations

For more information, see Setting Contexts, and Releasing Contexts:

To determine whether stream handle contexts are supported for a given file, call FltSupportsStreamHandleContexts
To allocate a new context, call FltAllocateContext.
To get a stream handle context, call FltGetStreamHandleContext.
To delete a stream handle context, call FltDeleteStreamHandleContext or FltDeleteContext.

Requirements

Requirement	Value
Minimum supported client	Available and supported in Microsoft Windows 2000 Update Rollup 1 for SP4, Windows XP SP2, Windows Server 2003 SP1, and later operating systems.
Target Platform	Universal
Header	fltkernel.h (include Fltkernel.h)
Library	Fltmgr.lib
DLL	Fltmgr.sys
IRQL	<= APC_LEVEL

Share via