Skip to content

Revise InitializeEnclave function documentation #2145

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: docs
Choose a base branch
from
Open

Revise InitializeEnclave function documentation #2145

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions sdk-api-src/content/enclaveapi/nf-enclaveapi-initializeenclave.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ For a list of common error codes, see [System Error Codes](/windows/win32/Debug/
| **ERROR_ENCLAVE_FAILURE** | An failure specific to the underlying enclave architecture occurred. The value for the *lpEnclaveError* parameter contains the architecture-specific error.<br/><br/>For the **ENCLAVE_TYPE_SGX** and **ENCLAVE_TYPE_SGX2** enclave types, the EINIT instruction that the [ENCLAVE_INIT_INFO_SGX](../winnt/ns-winnt-enclave_init_info_sgx.md) structure specified generated an error. The value of the *lpEnclaveError* parameter contains the error that the instruction generated. |
| **ERROR_BAD_LENGTH** | The value of the *dwInfoLength* parameter did not match the value expected based on the value specified for the *lpEnclaveInformation* parameter. |
| **ERROR_RETRY** | The processor was not able to initialize the enclave in a timely fashion. Try to initialize the enclave again. |
| **ERROR_MOD_NOT_FOUND** | The vertdll.dll module was not found loaded in the enclave. Ensure the enclave DLL calls at least one vertdll.dll API. |
Copy link
Contributor Author

@riverar riverar Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Struggled to find a consumer-friendly way to describe the DLL must be present in the Enclave DLL's import table so that it is loaded/available.


## -remarks

Expand All @@ -122,3 +123,4 @@ To create an enclave, use the [CreateEnclave](nf-enclaveapi-createenclave.md) fu
[VirtualFree](../memoryapi/nf-memoryapi-virtualfree.md)

[VirtualFreeEx](../memoryapi/nf-memoryapi-virtualfreeex.md)