Skip to content

Fix: Rename 'hkey' to 'hKey' to match standard casing in similar APIs… #2014

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.

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

Conversation

ajaymajukar
Copy link

… like RegOpenKeyExA

Ensures parameter naming consistency across registry API documentation.

… like RegOpenKeyExA

Ensures parameter naming consistency across registry API documentation.
Copy link

@ajaymajukar : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

@HBelusca
Copy link
Contributor

Does this match the casing used for the parameter of this function in the official Microsoft PSDK headers?

@ajaymajukar
Copy link
Author

Hi @HBelusca, thanks for addressing this PR.

As you asked, I have downloaded and installed the latest Windows SDK (version 10.0.26100) from the official site:
https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/

After checking the header file winreg.h at:
C:\Program Files (x86)\Windows Kits\10.0.26100.0\um\winreg.h

I noticed that only the RegGetValueA and RegGetValueW functions use the parameter name hkey (lowercase ‘k’), while the rest of the related functions use hKey (camelCase) for their parameters.

Since you asked whether the casing in the docs matches the official Microsoft PSDK headers for this specific function, I see that it does. Because of that, I think you would prefer to keep it consistent here in the MicrosoftDocs sdk-api as well.

However, I’m happy to defer to your guidance on how best to proceed with the pull request. Please let me know if you’d like me to update the PR accordingly or if you’d prefer to take it from here.

Thanks again for your help!

@HBelusca
Copy link
Contributor

I'm not from Microsoft, so I would suggest you wait for their reply instead. But from what I've noticed so far, their docs usually match what they have in their official headers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants