Edit

FN_VMB_CHANNEL_ALLOCATE 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 VmbChannelAllocate function allocates a new VMBus channel that has default parameters and callbacks.

Syntax

FN_VMB_CHANNEL_ALLOCATE FnVmbChannelAllocate;

NTSTATUS FnVmbChannelAllocate(
  PDEVICE_OBJECT ParentDeviceObject,
  BOOLEAN IsServer,
  VMBCHANNEL *Channel
)
{...}

Parameters

ParentDeviceObject

A pointer to the parent device.

IsServer

Whether the new channel is a server endpoint.

Channel

A pointer to an allocated channel.

Return value

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

Remarks

The channel may be further initialized using the VMBus channel initialization routines before it is enabled by using the VmbChannelEnable function. The channel must be freed by using the VmbChannelCleanup 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 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
IRQL PASSIVE_LEVEL

See also

VmbChannelCleanup

VmbChannelEnable