Edit

FN_VMB_CHANNEL_SAVE_BEGIN callback function (vmbuskernelmodeclientlibapi.h)

  • Article

[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 VmbChannelSaveBegin function initializes the context for saving the state of a channel. The driver must check the return value of the function.

Syntax

FN_VMB_CHANNEL_SAVE_BEGIN FnVmbChannelSaveBegin;

NTSTATUS FnVmbChannelSaveBegin(
  VMBCHANNEL Channel
)
{...}

Parameters

Channel

A handle for the channel to save.

Return value

Returns STATUS_SUCCESS if the operation succeeded, or an appropriate NTSTATUS error code otherwise.

Remarks

The caller next calls the VmbChannelSaveContinue function multiple times until all the state is saved, and then calls the VmbChannelSaveEnd function.

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
Header vmbuskernelmodeclientlibapi.h

See also

VmbChannelSaveContinue

VmbChannelSaveEnd