FN_VMB_CHANNEL_RESTORE_FROM_BUFFER - NtDoc
Native API online documentation, based on the System Informer
(formerly Process Hacker) phnt
headers
// vmbuskernelmodeclientlibapi.h
FN_VMB_CHANNEL_RESTORE_FROM_BUFFER FnVmbChannelRestoreFromBuffer;
NTSTATUS FnVmbChannelRestoreFromBuffer(
VMBCHANNEL Channel,
PVOID Buffer,
ULONG BufferSize
)
{...}
View the official Windows Driver Kit DDI referenceNo description available.
[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 VmbChannelRestoreFromBuffer function restores the client state from previously saved state. The driver must check the return value of the function.
ChannelA handle for a channel.
BufferA pointer to a buffer that contains previously saved state.
BufferSizeThe size, in bytes, of the buffer.
VmbChannelRestoreFromBuffer returns one of the following status values:
| Return code | Description |
|---|---|
| STATUS_SUCCESS | The function finished successfully. |
| STATUS_MORE_PROCESSING_REQUIRED | State was restored successfully, but more chunks were saved. |
| Other status code for which NT_SUCCESS is FALSE | The function failed. |
//Declaration
FN_VMB_CHANNEL_RESTORE_FROM_BUFFER FnVmbChannelRestoreFromBuffer;
// Definition
NTSTATUS FnVmbChannelRestoreFromBuffer
(
VMBCHANNEL Channel
PVOID Buffer
ULONG BufferSize
)
{...}
The caller is expected to call this function with buffers that contain whole "chunks" of stored data.
[!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.