PFSRTL_EXTRA_CREATE_PARAMETER_CLEANUP_CALLBACK function pointer

Article
01/08/2018

A file system filter driver (legacy filter) or a minifilter driver can register a PFSRTL_EXTRA_CREATE_PARAMETER_CLEANUP_CALLBACK-typed routine as the filter driver's CleanupCallback callback routine for an extra create parameter (ECP) context structure.

Syntax

typedef VOID ( *PFSRTL_EXTRA_CREATE_PARAMETER_CLEANUP_CALLBACK)(
  _Inout_ PVOID   EcpContext,
  _In_    LPCGUID EcpType
);

Parameters

EcpContext [in, out]
An ECP context pointer that was returned by the routine that allocated the ECP context structure.
EcpType [in]
A pointer to a GUID that was passed to the routine that allocated the ECP context structure, that indicates the extra create parameter type. For more information, see Using GUIDs in Drivers.

Return value

None

Remarks

When a file system filter driver (legacy filter) or a minifilter driver allocates an ECP context structure, it can optionally specify a PFSRTL_EXTRA_CREATE_PARAMETER_CLEANUP_CALLBACK-typed routine as the filter driver's CleanupCallback callback routine. If the filter driver specifies a CleanupCallback callback routine, the operating system will invoke the CleanupCallback routine (regardless of IRQ level). This CleanupCallback routine performs any necessary ECP context-related cleanup processing when the ECP context structure is deleted.

To specify a callback routine, a filter driver passes a pointer to the callback routine by using the CleanupCallback parameter of the routine that originally allocated the ECP context structure. If a callback routine is not needed, a NULL value must be passed to the CleanupCallback parameter.

The following routines support the PFSRTL_EXTRA_CREATE_PARAMETER_CLEANUP_CALLBACK-typed callback routine:

Requirements

Target platform	Desktop
Version	Available in Windows Vista and later versions of all Windows operating systems.
Header	Ntifs.h (include Ntifs.h or FltKernel.h)
IRQL	PASSIVE_LEVEL

Share via