TerminateEnclave function (enclaveapi.h)

Ends the execution of the threads that are running within an enclave.

Syntax

BOOL TerminateEnclave(
  [in] LPVOID lpAddress,
  [in] BOOL   fWait
);

Parameters

[in] lpAddress

The base address of the enclave in which to end the execution of the threads.

[in] fWait

TRUE if TerminateEnclave should not return until all of the threads in the enclave end execution. FALSE if TerminateEnclave should return immediately.

Return value

TRUE if the function succeeds; otherwise FALSE. To get extended error information, call GetLastError.

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	enclaveapi.h
Library	onecore.lib
DLL	kernel32.dll; Api-ms-win-core-enclave-l1-1-0.dll

See also

Enclave functions

CallEnclave

Vertdll APIs available in VBS enclaves