EVT_VMB_CHANNEL_CLOSED 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 EvtVmbChannelClosed callback function is invoked when the client endpoint in the guest virtual machine closes a channel by using the VmbChannelDisable function, or the opposite endpoint rescinds or closes the channel.

Syntax

EVT_VMB_CHANNEL_CLOSED EvtVmbChannelClosed;

void EvtVmbChannelClosed(
  [in] VMBCHANNEL Channel
)
{...}

Parameters

[in] Channel

The channel that the guest virtual machine closes.

Return value

None

Remarks

After a channel is created, a client driver can specify callback functions for state changes, including EvtVmbChannelClosed, by using the VMB_CHANNEL_STATE_CHANGE_CALLBACKS_INIT function.

After this callback function finishes on the host, the channel is either closed or disabled, depending on whether the guest closed the channel or the Kernel Mode Client Library (KMCL) client called VmbChannelDisable, respectively.

On the guest, the channel always becomes disabled. It must be restarted by using the VmbChannelEnable function.

After this is function invoked, packets can be queued, but they cannot be sent.

Requirements

Requirement Value
Target Platform Windows
Header vmbuskernelmodeclientlibapi.h (include VmbusKernelModeClientLibApi.h)
IRQL PASSIVE_LEVEL

See also

VMB_CHANNEL_STATE_CHANGE_CALLBACKS_INIT

VmbChannelDisable

VmbChannelEnable