Skip to content

Correct parameter name in ImageLockMode.UserInputBuffer description #11334

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

Merged
merged 2 commits into from
May 23, 2025

Conversation

mriehm
Copy link
Contributor

@mriehm mriehm commented May 22, 2025

The docs for the UserInputBuffer value of the ImageLockMode enum in System.Drawing refer to the flags parameter as being input or output, which makes no sense. It should refer to the bitmapData parameter instead.
This can be confirmed by referencing the docs for the ImageLockMode enum in GDI+, from which the System.Drawing version of the documentation appears to have been copied.

@mriehm mriehm requested a review from a team as a code owner May 22, 2025 19:44
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates that the PR has been added by a community member label May 22, 2025
@github-actions github-actions bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label May 22, 2025
@mriehm mriehm changed the title Correct parameter name in ImageLockModeUserInputBuf description Correct parameter name in ImageLockMode.UserInputBuf description May 22, 2025
@mriehm mriehm changed the title Correct parameter name in ImageLockMode.UserInputBuf description Correct parameter name in ImageLockMode.UserInputBuffer description May 22, 2025
Copy link
Contributor

Tagging subscribers to this area: @dotnet/area-system-drawing

Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

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

Thanks, good catch. My suggestion is to also link to the specific overload that has a bitmapData parameter.

@gewarren gewarren removed the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label May 22, 2025
@gewarren gewarren merged commit ed67b23 into dotnet:main May 23, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-System.Drawing community-contribution Indicates that the PR has been added by a community member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants