PMRX_FINALIZE_V_NET_ROOT_CALLDOWN callback function (mrx.h)

Article
10/12/2023

The MRxFinalizeVNetRoot routine is called by RDBSS to request that a network mini-redirector finalize a V_NET_ROOT structure.

Syntax

PMRX_FINALIZE_V_NET_ROOT_CALLDOWN PmrxFinalizeVNetRootCalldown;

NTSTATUS PmrxFinalizeVNetRootCalldown(
  IN OUT PMRX_V_NET_ROOT VirtualNetRoot,
  IN PBOOLEAN Force
)
{...}

Parameters

VirtualNetRoot

[in, out] A pointer to the V_NET_ROOT structure to finalize.

Force

[in] A pointer to a Boolean value that indicates if the disconnect is to be forced. RDBSS currently passes FALSE for this parameter in all cases.

Return value

MRxFinalizeVNetRoot returns STATUS_SUCCESS on success.

Remarks

MRxFinalizeVNetRoot is called by RDBSS when it finalizes a NET_ROOT structure.

After the MRxFinalizeVNetRoot returns, RDBSS uninitializes the V_NET_ROOT structure members, dereferences the NET_ROOT structure, and releases the memory for the V_NET_ROOT structure.

RDBSS ignores the return value from MRxFinalizeVNetRoot.

Requirements

Requirement	Value
Target Platform	Desktop
Header	mrx.h (include Mrx.h)