Revise InitializeEnclave function documentation #2145
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated the documentation for the InitializeEnclave function to callout `ERROR_MOD_NOT_FOUND` scenario and requirement to ensure vertdll is in enclave dll IAT.
|
@riverar : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change. |
riverar
commented
Nov 26, 2025
| | **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. | |
Contributor
Author
There was a problem hiding this comment.
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.
Contributor
|
Thanks, @riverar. I've added @CodeMaxx from the engineering side to make sure this sounds good to him. This PR may get re-assigned to another writer from the team. I'm moving to the Microsoft Foundry docs team this week, but I'm trying to help wrap up as much of my open work as possible during the transition. |
Contributor
Author
|
Thanks @alvinashcraft no worries. There's an open team discussion here microsoft/VbsEnclaveTooling#148 (comment) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated the documentation for the InitializeEnclave function to callout
ERROR_MOD_NOT_FOUNDscenario and requirement to ensure vertdll is in enclave dll IAT.