__vmx_vmread

Microsoft Specific

Reads a specified field from the current virtual machine control structure (VMCS) and places it in the specified location.

Syntax

unsigned char __vmx_vmread(
   size_t Field,
   size_t *FieldValue
);

Parameters

Parameter Description
Field [in] The VMCS field to read.
FieldValue [in] A pointer to the location to store the value read from the VMCS field specified by the Field parameter.

Return Value

Value Meaning
0 The operation succeeded.
1 The operation failed with extended status available in the VM-instruction error field of the current VMCS.
2 The operation failed without status available.

Remarks

The __vmx_vmread function is equivalent to the VMREAD machine instruction. The value of the Field parameter is an encoded field index that is described in Intel documentation. For more information, search for the document, "Intel Virtualization Technical Specification for the IA-32 Intel Architecture," document number C97063-002, at the Intel Corporation site, then consult Appendix C of that document.

Requirements

Intrinsic Architecture
__vmx_vmread x64

Header file <intrin.h>

END Microsoft Specific

See also

Compiler Intrinsics
__vmx_vmwrite