EnclaveGetEnclaveInformation function (winenclaveapi.h)

Article
02/22/2024

Gets information about the currently executing enclave.

Syntax

HRESULT EnclaveGetEnclaveInformation(
  [in]  UINT32              InformationSize,
  [out] ENCLAVE_INFORMATION *EnclaveInformation
);

Parameters

[in] InformationSize

The size of the ENCLAVE_INFORMATION structure that the EnclaveInformation parameter points to, in bytes.

[out] EnclaveInformation

Information about the currently executing enclave.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

EnclaveGetEnclaveInformation must be called from within an enclave, and is only supported within enclaves that have the ENCLAVE_TYPE_VBS enclave type.

Requirements

Requirement	Value
Minimum supported client	Windows 10, version 1709 [desktop apps only]
Minimum supported server	Windows Server 2016 [desktop apps only]
Target Platform	Windows
Header	winenclaveapi.h
Library	Vertdll.lib
DLL	Vertdll.dll