Skip to content

Latest commit

 

History

History
98 lines (72 loc) · 3.77 KB

nf-fltkernel-fltdeletestreamcontext.md

File metadata and controls

98 lines (72 loc) · 3.77 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NF:fltkernel.FltDeleteStreamContext
FltDeleteStreamContext function (fltkernel.h)
FltDeleteStreamContext removes a context that a given minifilter driver instance has set for a given stream and marks the context for deletion.
ifsk\fltdeletestreamcontext.htm
ifsk
01/22/2021
FltDeleteStreamContext function
FltApiRef_a_to_d_8339a254-56eb-4f75-b294-006286f3ff10.xml, FltDeleteStreamContext, FltDeleteStreamContext function [Installable File System Drivers], fltkernel/FltDeleteStreamContext, ifsk.fltdeletestreamcontext
fltkernel.h
Fltkernel.h
Universal
FltMgr.lib
<= APC_LEVEL
Windows
FltDeleteStreamContext
fltkernel/FltDeleteStreamContext
APIRef
kbSyntax
LibDef
FltMgr.lib
FltMgr.dll
FltDeleteStreamContext

FltDeleteStreamContext function

-description

FltDeleteStreamContext removes a context that a given minifilter driver instance has set for a given stream and marks the context for deletion.

-parameters

-param Instance [in]

Opaque instance pointer for the minifilter driver instance whose context is to be removed from the list of contexts attached to the file stream.

-param FileObject [in]

Pointer to a file object for the file stream.

-param OldContext [out]

Pointer to a caller-allocated variable that receives the address of the deleted context. This parameter is optional and can be NULL. If OldContext is not NULL and does not point to NULL_CONTEXT, the caller is responsible for calling FltReleaseContext to release this context when it is no longer needed.

-returns

FltDeleteStreamContext returns STATUS_SUCCESS or an appropriate NTSTATUS value such as one of the following:

Return code Description
STATUS_FLT_DELETING_OBJECT The specified Instance is being torn down. This is an error code.
STATUS_NOT_FOUND No matching context was found. This is an error code.
STATUS_NOT_SUPPORTED The file system does not support per-stream contexts for this file stream. This is an error code.

-remarks

For more information about contexts, see About minifilter contexts.

Because contexts are reference-counted, it is not usually necessary for a minifilter driver to call a routine such as FltDeleteStreamContext to explicitly delete a context.

A minifilter driver calls FltDeleteStreamContext to remove a context from a file stream and mark the context for deletion. The context is usually freed immediately unless there is an outstanding reference on it (for example, because the context is still in use by another thread).

To allocate a new context, call FltAllocateContext.

To get a stream context, call FltGetStreamContext.

To set a stream context, call FltSetStreamContext.

-see-also

FltAllocateContext

FltDeleteContext

FltGetStreamContext

FltReleaseContext

FltSetStreamContext