HvReleaseEventLogBuffer function

The HvReleaseEventLogBuffer function releases the completed buffer to the hypervisor as a free buffer.

Syntax


HV_STATUS  HvReleaseEventLogBuffer(
  _In_  HV_EVENTLOG_TYPE Type,
  _In_  HV_EVENTLOG_BUFFER_INDEX BufferIndex
);

Parameters

Type [in]: A HV_EVENTLOG_TYPE value that specifies the type of the event log buffer group whose buffer is released.
BufferIndex [in]: An HV_EVENTLOG_BUFFER_INDEX value that specifies the index of the buffer within the buffer group that is associated with the event log type that the Type parameter specifies.

Return value

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

Return code	Description
HV_STATUS_SUCCESS	HvReleaseEventLogBuffer successfully released a single event log buffer.
HV_STATUS_ACCESS_DENIED	The caller is not the root partition.
HV_STATUS_INVALID_PARAMETER	The specified event log type is invalid.
HV_STATUS_OPERATION_DENIED	One of the following conditions exists: The event log buffer group has not been initialized. An event log buffer of the specified type with the specified index has not been created. The specified event log buffer is not in the ready state.

Remarks

If the event log buffer that is specified is not in the ready state, HvReleaseEventLogBuffer returns HV_STATUS_OPERATION_DENIED. HvReleaseEventLogBuffer informs the hypervisor that the guest is finished processing the buffer. The hypervisor will place the buffer into a free state and make the buffer available for reuse.

HvReleaseEventLogBuffer has the following restrictions:

The caller must be the root partition.
The buffer that is specified by BufferIndex must be in the complete state.

Native Interface

HvReleaseEventLogBuffer [fast]
	Call Code = 0x0067
Input Parameters
0	Type (4 bytes) BufferIndex (4 bytes)

Requirements