FwpsAcquireClassifyHandle0 function (fwpsk.h)

Article
02/22/2024

The FwpsAcquireClassifyHandle0 function generates a classification handle that is used to identify asynchronous classification operations and requests for writable layer data.

Note FwpsAcquireClassifyHandle0 is a specific version of FwpsAcquireClassifyHandle. See WFP Version-Independent Names and Targeting Specific Versions of Windows for more information.

Syntax

NTSTATUS FwpsAcquireClassifyHandle0(
  [in]  void   *classifyContext,
  [in]  UINT32 flags,
  [out] UINT64 *classifyHandle
);

Parameters

[in] classifyContext

The classifyContext parameter from classifyFn1. The WFP engine passes this value to the callout driver's classifyFn.

[in] flags

Reserved for future use. Set to 0.

[out] classifyHandle

A pointer to a variable that receives a classification handle. This handle is needed by subsequent function calls as noted in Remarks.

Return value

The FwpsAcquireClassifyHandle0 function returns one of the following NTSTATUS codes.

Return code	Description
STATUS_SUCCESS	A handle to the classify request was successfully returned. The variable that the classifyHandle parameter points to contains the handle for the classify request.
Other status codes	An error occurred.

Remarks

FwpsAcquireClassifyHandle0 is a support function for asynchronous classification and data modification. The handle returned by this function is required as a parameter for the following functions:

For each call to this function, the callout driver must call FwpsReleaseClassifyHandle0 to free the system resources associated with the handle.

Requirements

Requirement	Value
Minimum supported client	Available starting with Windows 7.
Target Platform	Universal
Header	fwpsk.h (include Fwpsk.h)
Library	Fwpkclnt.lib
IRQL	<= DISPATCH_LEVEL