FN_VMB_SERVER_CHANNEL_INIT_SET_SAVE_RESTORE_PACKET_CALLBACKS callback function (vmbuskernelmodeclientlibapi.h)

Article
02/22/2024

The VmbServerChannelInitSetSaveRestorePacketCallbacks function sets the save and restore callback functions that are called for each packet when the driver calls a save function, such as VmbChannelSaveBegin, VmbChannelSaveContinue, and VmbChannelSaveEnd, or the VmbChannelRestoreFromBuffer function.

Syntax

FN_VMB_SERVER_CHANNEL_INIT_SET_SAVE_RESTORE_PACKET_CALLBACKS FnVmbServerChannelInitSetSaveRestorePacketCallbacks;

NTSTATUS FnVmbServerChannelInitSetSaveRestorePacketCallbacks(
  VMBCHANNEL Channel,
  PFN_VMB_CHANNEL_SAVE_PACKET SavePacketCallback,
  PFN_VMB_CHANNEL_RESTORE_PACKET RestorePacketCallback
)
{...}

Parameters

Channel

A handle for a channel.

SavePacketCallback

A callback function to call during channel save.

RestorePacketCallback

A callback function to call during channel restore.

Return value

VmbServerChannelInitSetSaveRestorePacketCallbacks returns the following status values:

Return code	Description
STATUS_INVALID_PARAMETER_1	The Channel value was invalid or in an invalid state, such as Disabled.

Remarks

Important

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

For more information, see the Remarks section of KMCL_SERVER_ONLY_METHODS.

Requirements

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