HvResetDebugSession function

The HvResetDebugSession function resets the incoming and outgoing buffer context.

Syntax


HV_STATUS  HvResetDebugSession(
  _In_  HV_DEBUG_OPTIONS Options
);

Parameters

Options [in]: A valid bitwise OR combination of HV_DEBUG_OPTIONS values that specify the reset options. The caller can specify whether the hypervisor should purge the incoming session buffer, the outgoing session buffer, or both session buffers. The caller can set HV_DEBUG_PURGE_INCOMING_DATA to purge all incoming data pending retrieval. The caller can set HV_DEBUG_PURGE_OUTGOING_DATA to purge all outgoing data pending transmission.

Return value

HvResetDebugSession returns one of the following values. In addition to these values, HvResetDebugSession can also return one of the values that are specified in Common Hypercall Status Codes.

Return code	Description
HV_STATUS_SUCCESS	HvResetDebugSession successfully reset the incoming and outgoing buffer context.
HV_STATUS_FEATURE_UNAVAILABLE	Guest debugging support is not present or is not enabled in the hypervisor.
HV_STATUS_ACCESS_DENIED	The caller's partition does not possess the Debugging privilege.
HV_STATUS_OPERATION_DENIED	The partition's Debug Channel Identifier property has not been assigned a unique, nonzero value.
HV_STATUS_INVALID_PARAMETER	The Options parameter includes an unsupported flag or includes neither HV_DEBUG_PURGE_INCOMING_DATA nor HV_DEBUG_PURGE_OUTGOING_DATA.
HV_STATUS_NO_DATA	No data was purged from the buffers that the Options flags specify.

Remarks

HvResetDebugSession directs the hypervisor to purge all internal receive and transmit buffers for the session. Pending data is lost. HvResetDebugSession is designed to be used when the caller must reset the state of the connection.

HvResetDebugSession has the following restrictions:

The partition must possess the Debugging privilege.

Native Interface

HvResetDebugSession [fast]
	Call Code = 0x006B
Input Parameters
0	Options (4 bytes) Padding (4 bytes)

Requirements

Version	HvResetDebugSession is available in version 1.0 and later versions of the hypervisor.
Header	Hvgdk.h (include Hvgdk.h)
IRQL	Any level

Send comments about this topic to Microsoft

Build date: 11/16/2013