Add missing _COM_Outptr_ SAL to DxcCreateInstance and friends
#4524
Conversation
This file contains 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
Ever since [windows-rs started requiring SAL] for properly processing functions that return a COM instance these annotations had to be added. They seem to be present on most functions and were [worked around for `DxcCreateInstance(2)` in `win32`metadata] (yet their `*Proc` `typedef` variants were omitted). [windows-rs started requiring SAL]: microsoft/windows-rs#1088 (comment) [worked around for `DxcCreateInstance(2)` in `win32`metadata]: https://github.com/microsoft/win32metadata/pull/890/files
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Ever since windows-rs started requiring SAL for properly processing functions that return a COM instance these annotations had to be added. They seem to be present on most functions and were worked around for
DxcCreateInstance(2)inwin32metadata (yet their*Proctypedefvariants were omitted).This includes more random functions that were spotted (particularly the
_Out_ IDxc*pattern) but I have been unable to check the nullability for every variant. As per the documentation these_COM_Outptr_annotations already include the notion of leaving/setting this output pointer toNULLin an error case, in which case a non-S_OKHRESULTshould also be returned.