microsoft / microsoft/win32metadata
Inconsistent documentation/interface of AcceptSecurityContext
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 1.5k
- Forks
- 149
- Avg merge
- 5d 16h
- Merged PRs (30d)
- 4
Description
Hi everyone!
Not sure where I should put this so I'll put it here:
The [Documentation for AcceptSecurityContext (Negotiate)](https://learn.microsoft.com/en-us/windows/win32/secauthn/acceptsecuritycontext--negotiate) says that the parameter `phNewContext` should never be null and is a pointer that's only being written to
(it is of course also the incoming information, as it's supposed to be the same as `phContext` in subsequent calls, but that's what `phContext` is supposedly being read for)
Despite this, it's marked as `optional` in the docs.
This pointer should probably not be marked as optional, as putting a null here will cause an access violation.
Whether it's an actual input pointer should probably at least be debated.
Cheers
Niclas
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the AcceptSecurityContext (Negotiate) API metadata or interface definition and compare phNewContext with the linked Microsoft documentation. Confirm how the parameter is currently marked and whether the generated interface reflects that annotation. Done means the interface no longer presents phNewContext as optional, with the documentation discrepancy resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- api
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100