FN_VMB_SERVER_CHANNEL_INIT_SET_VMBUS_HANDLE - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers
// vmbuskernelmodeclientlibapi.h

FN_VMB_SERVER_CHANNEL_INIT_SET_VMBUS_HANDLE FnVmbServerChannelInitSetVmbusHandle;

NTSTATUS FnVmbServerChannelInitSetVmbusHandle(
  VMBCHANNEL Channel,
  HANDLE VmbusHandle
)
{...}
View the official Windows Driver Kit DDI reference

NtDoc

No description available.

Windows Driver Kit DDI reference (nc-vmbuskernelmodeclientlibapi-fn_vmb_server_channel_init_set_vmbus_handle)

FN_VMB_SERVER_CHANNEL_INIT_SET_VMBUS_HANDLE callback function

Description

The VmbServerChannelInitSetVmbusHandle function associates an instance of VMBus with this channel.

Parameters

Channel

A handle for a channel.

VmbusHandle

A kernel mode handle to the VMBus vdev of the partition.

Return value

Returns STATUS_SUCCESS if the operation is successful. Otherwise, returns an appropriate NTSTATUS error code.

Prototype

//Declaration

FN_VMB_SERVER_CHANNEL_INIT_SET_VMBUS_HANDLE FnVmbServerChannelInitSetVmbusHandle;

// Definition

NTSTATUS FnVmbServerChannelInitSetVmbusHandle
(
    VMBCHANNEL Channel
    HANDLE VmbusHandle
)
{...}

Remarks

The VMBus instance was previously initialized for the specific guest virtual machine. Therefore, invoking this function identifies the child virtual machine to which this channel is offered.

Obtain a value for the VmbusHandle parameter by using the VmbConvertVmbusHandleToKernelHandle function.

This function can be called while running in any thread context.

[!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.

See also

VmbConvertVmbusHandleToKernelHandle