FltCommitFinalizeComplete function (fltkernel.h)

Article
10/21/2021

The FltCommitFinalizeComplete routine acknowledges a TRANSACTION_NOTIFY_COMMIT_FINALIZE notification.

Syntax

NTSTATUS FLTAPI FltCommitFinalizeComplete(
  [in]           PFLT_INSTANCE Instance,
  [in]           PKTRANSACTION Transaction,
  [in, optional] PFLT_CONTEXT  TransactionContext
);

Parameters

[in] Instance

Opaque pointer to an instance of a minifilter driver. This parameter is required and cannot be NULL.

[in] Transaction

Opaque pointer to the transaction the minifilter driver is currently enlisted in. This parameter is required and cannot be NULL.

[in, optional] TransactionContext

Pointer to the minifilter driver's context for the transaction. This parameter is optional and can be NULL.

Return value

FltCommitFinalizeComplete returns STATUS_SUCCESS or an appropriate NTSTATUS value, such as the following:

Return code	Description
STATUS_NOT_FOUND	The minifilter driver did not set a context on the transaction. This is an error code.

Remarks

A minifilter driver that is enlisted in a transaction can receive a TRANSACTION_NOTIFY_COMMIT_FINALIZE notification when the transaction is fully committed (that is, when all of the resource managers associated with the transaction, such as TxF, have committed). For an antivirus minifilter driver that performs scans outside of transactions, you can use this notification value to determine when the driver should begin scanning files.

To send the TRANSACTION_NOTIFY_COMMIT_FINALIZE notification to the minifilter driver, the filter manager calls the minifilter driver's TransactionNotificationCallback routine. The minifilter driver acknowledges this notification in one of two ways:

The minifilter driver's TransactionNotificationCallback routine performs any required processing and returns STATUS_SUCCESS. (In this case, the minifilter driver does not call FltCommitFinalizeComplete.)
The minifilter driver's TransactionNotificationCallback routine posts any required processing to a worker thread and returns STATUS_PENDING. After performing the processing asynchronously, the minifilter driver's worker thread routine must call FltCommitFinalizeComplete to indicate that it has finished this processing. If the minifilter driver's worker thread routine does not call FltCommitFinalizeComplete, certain system resources will be leaked.

To register a TransactionNotificationCallback routine, a minifilter driver stores the address of a routine of type PFLT_TRANSACTION_NOTIFICATION_CALLBACK in the TransactionNotificationCallback member of the FLT_REGISTRATION structure that the minifilter driver passes as the Registration parameter of FltRegisterFilter.

To enlist in a transaction, call FltEnlistInTransaction.

To allocate a new transaction context, call FltAllocateContext.

To retrieve a transaction context, call FltGetTransactionContext.

To delete a transaction context, call FltDeleteTransactionContext or FltDeleteContext.

To set a transaction context, call FltSetTransactionContext.

For more information, see Transaction Notifications.

Requirements

Requirement	Value
Minimum supported client	Available in Windows Vista Service Pack 1 (SP1) and later.
Target Platform	Universal
Header	fltkernel.h (include Fltkernel.h)
Library	Fltmgr.lib
IRQL	<= APC_LEVEL