FN_VMB_CHANNEL_PACKET_FAIL callback function (vmbuskernelmodeclientlibapi.h)

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

The VmbChannelPacketFail function fails a packet during packet processing due to an unrecoverable error. This function stops the queue.

Syntax

FN_VMB_CHANNEL_PACKET_FAIL FnVmbChannelPacketFail;

void FnVmbChannelPacketFail(
  VMBPACKETCOMPLETION PacketCompletionContext
)
{...}

Parameters

PacketCompletionContext

A handle that identifies the incoming packet and is used to refer to the packet once processing is finished.

Return value

None

Remarks

Call this function for packets presented to the server endpoint which seem malformed, to the extent that channel processing should cease.

Important

This function is called through the VMBus Kernel Mode Client Library (KMCL) interface, provided by the Vmbkmcl.sys bus driver. This is a client function accessed from the KMCL_CLIENT_INTERFACE_V1 structure.

For more information, see the Remarks section of the KMCL_CLIENT_INTERFACE_V1.

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 1803
Header	vmbuskernelmodeclientlibapi.h