Skip to content

Update CsWin32 to 0.3.287 and remove .NET Framework IComIID workarounds#14639

Open
JeremyKuhne wants to merge 4 commits into
dotnet:mainfrom
JeremyKuhne:update-cswin32-0.3.287
Open

Update CsWin32 to 0.3.287 and remove .NET Framework IComIID workarounds#14639
JeremyKuhne wants to merge 4 commits into
dotnet:mainfrom
JeremyKuhne:update-cswin32-0.3.287

Conversation

@JeremyKuhne

@JeremyKuhne JeremyKuhne commented Jun 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Summary

Updates Microsoft.Windows.CsWin32 from 0.3.151 to 0.3.287 and removes the manual IComIID workarounds we maintained for .NET Framework.

CsWin32 0.3.287 now emits the IComIID interface for net472 / netstandard2.0 (see microsoft/CsWin32#1704). Previously it only generated IComIID for modern .NET, which is why we hand-authored the interface and appended : IComIID to each COM struct under the Framework folder. Those workarounds are now redundant.

Changes

Core request

  • Bump MicrosoftWindowsCsWin32PackageVersion 0.3.151 → 0.3.287.
  • Delete the manual IComIID interface definition and the 12 COM struct partials under System.Private.Windows.Core/src/Framework/Windows/Win32/ that implemented it. The shared IID.cs already handles the static-vs-instance difference via #if NET, so it needs no change.

Fallout from the version bump (required to keep the solution building)

  • Optional out-pointer parameters are now out (WideCharToMultiByte, SHParseDisplayName, get_accHelpTopic, DrawThemeEdge, GetThemeBackgroundRegion).
  • DocumentProperties now takes PRINTER_HANDLE instead of HANDLE.
  • Some buffer methods lost their string-friendly overloads; pin strings and pass PCWSTR (GetThemeDocumentationProperty, RegLoadMUIString, GetShortPathName, GetLocaleInfoEx).
  • DrawFrameControl dropped its DFC_TYPE / DFCS_STATE enums (now uint). Re-requested both enums in NativeMethods.txt so the public ButtonState / ScrollButton enum values are preserved, and added (uint) casts at call sites.
  • Suppressed new CLS-compliance warnings on generated COM structs (CS3021 in the Core projects, CS3019 in Primitives), grouped with the existing CS3016 suppression.
  • Updated XML doc crefs that referenced changed signatures.

Validation

Clean rebuild of the full solution (dotnet build Winforms.sln -t:Rebuild -p:TreatWarningsAsErrors=true) succeeds with 0 errors and 0 warnings across all src, facade, analyzer, source-generator, and test projects.

Microsoft Reviewers: Open in CodeFlow

@JeremyKuhne
Update CsWin32 to 0.3.287 and remove .NET Framework IComIID hacks
df3c6a2 
CsWin32 0.3.287 now emits the IComIID interface for net472/netstandard2.0
(microsoft/CsWin32#1704), so the manual definitions and per-struct
implementations we maintained for .NET Framework are no longer needed.

- Bump MicrosoftWindowsCsWin32PackageVersion 0.3.151 -> 0.3.287
- Delete the manual IComIID interface and the 12 COM struct partials under
  System.Private.Windows.Core/src/Framework that appended : IComIID

Adapt to generated-signature changes from the version bump:
- Optional out-pointer params are now 'out' (WideCharToMultiByte,
  SHParseDisplayName, get_accHelpTopic, DrawThemeEdge, GetThemeBackgroundRegion)
- DocumentProperties now takes PRINTER_HANDLE
- Buffer methods lost string-friendly overloads; pin strings for PCWSTR
- Re-request DFC_TYPE/DFCS_STATE in NativeMethods.txt (DrawFrameControl now
  takes uint) so public ButtonState/ScrollButton enum values are preserved
- Suppress new CLS warnings on generated COM structs (CS3021/CS3019)
- Update XML doc crefs to match new signatures
@JeremyKuhne JeremyKuhne requested a review from a team as a code owner June 11, 2026 17:28
@JeremyKuhne JeremyKuhne changed the title Update CsWin32 to 0.3.287 and remove .NET Framework IComIID hacks Update CsWin32 to 0.3.287 and remove .NET Framework IComIID workarounds Jun 11, 2026
jevansaks
jevansaks reviewed Jun 11, 2026
View reviewed changes
Comment thread src/System.Windows.Forms/System/Windows/Forms/Rendering/ControlPaint.cs
jevansaks
jevansaks reviewed Jun 11, 2026
View reviewed changes
Comment thread src/System.Windows.Forms.Primitives/src/Windows/Win32/PInvoke.SHCreateShellItem.cs Outdated
jevansaks
jevansaks reviewed Jun 11, 2026
View reviewed changes
Comment thread src/System.Windows.Forms/System/Windows/Forms/Help/Help.cs
Shyam-Gupta
Shyam-Gupta previously approved these changes Jun 11, 2026
View reviewed changes

@Shyam-Gupta Shyam-Gupta left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

:shipit: Looks good. Thanks Jeremy.

KlausLoeffelmann
KlausLoeffelmann requested changes Jun 11, 2026
View reviewed changes

@KlausLoeffelmann KlausLoeffelmann left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I would like to know more first about the motivation behind this, and why we need to do this now.

@dotnet-policy-service dotnet-policy-service Bot added the waiting-author-feedback The team requires more information from the author label Jun 11, 2026
@KlausLoeffelmann

KlausLoeffelmann commented Jun 11, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

This is not a good point in time to take this PR, as I am really busy to introduce a series of APIs for .NET 11.

@JeremyKuhne, next time you plan a change like that, I'd like you to check with me first.

Can this PR wait until after we merged for .NET 11?

Is this a PR that is immediately needed for an initiative I would not know about which this cannot wait?

Let me see, if I can find the time, to quickly rebase to PRs I got on this and see, if they are in any way affected by this.

@merriemcgaw , @mcastro-x FYI.

@JeremyKuhne
Address PR feedback: prefer omitted optional out params and friendly …
e7ae8f6 
…overloads

- WideCharToMultiByte/SHParseDisplayName: omit the optional out param instead of passing 'out _' so the call truly passes null (out _ is not equivalent to null).

- GetShortPathName (Help.cs): use the friendly Span<char> overload, removing manual pinning.

RegLoadMUIString is intentionally left on the raw overload: its friendly Span overload passes the char count as cbOutBuf, which the API documents as a byte count, so it would misreport the buffer size.
@dotnet-policy-service dotnet-policy-service Bot removed the waiting-author-feedback The team requires more information from the author label Jun 11, 2026
@JeremyKuhne

JeremyKuhne commented Jun 11, 2026

Copy link
Copy Markdown
Member Author

@KlausLoeffelmann you do not need to review if you're too busy, @Shyam-Gupta has signed up for this. This is a low impact change that applies follow up changes upstream to changes in this and other repos.

@JeremyKuhne JeremyKuhne mentioned this pull request Jun 12, 2026
Merged
@KlausLoeffelmann KlausLoeffelmann requested a review from Copilot June 12, 2026 19:31
Copilot AI reviewed Jun 12, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates the repo’s CsWin32-generated interop layer to Microsoft.Windows.CsWin32 0.3.287, removing now-redundant .NET Framework IComIID workarounds and adjusting call sites/docs/projects to match the new generated signatures and types.

Changes:

  • Bump Microsoft.Windows.CsWin32 package version and adjust call sites for updated P/Invoke signatures (e.g., out parameters, removed optional params, PCWSTR usage, uint-typed enums).
  • Remove hand-authored .NET Framework IComIID interface and related COM struct partials under src/System.Private.Windows.Core/src/Framework/Windows/Win32/.
  • Update project warning suppressions and documentation crefs impacted by the generator changes.

Reviewed changes

Copilot reviewed 33 out of 33 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/System.Windows.Forms/System/Windows/Forms/VisualStyles/VisualStyleRenderer.cs Updates theming P/Invoke calls to use out parameters.
src/System.Windows.Forms/System/Windows/Forms/Rendering/ControlPaint.cs Adjusts DrawFrameControl calls to match uint signature.
src/System.Windows.Forms/System/Windows/Forms/Printing/PrinterSettingsExtensions.cs Updates DocumentProperties handle type to PRINTER_HANDLE.
src/System.Windows.Forms/System/Windows/Forms/Printing/PageSetupDialog.cs Updates GetLocaleInfoEx call site for new parameter type.
src/System.Windows.Forms/System/Windows/Forms/Help/Help.cs Updates GetShortPathName usage for new overloads (has a behavioral bug—see comment).
src/System.Windows.Forms/System/Windows/Forms/Controls/DataGridView/DataGridViewCheckBoxCell.cs Updates DrawFrameControl usage to match new uint signature.
src/System.Windows.Forms/System/Windows/Forms/Controls/Buttons/ButtonInternal/CheckBoxBaseAdapter.cs Updates DrawFrameControl usage to match new uint signature.
src/System.Windows.Forms/System/Windows/Forms/Accessibility/AccessibleObjectExtensions.cs Updates get_accHelpTopic call to new out pattern.
src/System.Windows.Forms.Primitives/tests/UnitTests/Interop/Shell32/ShellItemTests.cs Updates test for SHParseDisplayName signature change.
src/System.Windows.Forms.Primitives/src/Windows/Win32/PInvoke.SHCreateShellItem.cs Updates helper to match SHParseDisplayName signature change.
src/System.Windows.Forms.Primitives/src/Windows/Win32/Pinvoke.RegLoadMUIString.cs Pins and passes PCWSTR for updated RegLoadMUIString signature; updates cref.
src/System.Windows.Forms.Primitives/src/Windows/Win32/PInvoke.GetThemeDocumentationProperty.cs Pins strings and passes PCWSTR for updated signature.
src/System.Windows.Forms.Primitives/src/System.Windows.Forms.Primitives.csproj Adds CS3019 suppression for new generator-emitted CLS attributes.
src/System.Windows.Forms.Primitives/src/NativeMethods.txt Requests DFC_TYPE / DFCS_STATE enums to preserve typed usage.
src/System.Windows.Forms.Primitives/src/Microsoft/VisualStudio/Shell/IVsPerPropertyBrowsing.cs Updates XML doc cref to match signature changes.
src/System.Private.Windows.Core/src/System/Private/Windows/Ole/Composition.ManagedToNativeAdapter.cs Updates WideCharToMultiByte calls for signature change.
src/System.Private.Windows.Core/src/System.Private.Windows.Core.csproj Adds CS3021 suppression for new generator-emitted CLS attributes.
src/System.Private.Windows.Core/src/Microsoft.Private.Windows.Core.csproj Adds CS3021 suppression for new generator-emitted CLS attributes.
src/System.Private.Windows.Core/src/Framework/Windows/Win32/UI/Shell/IDropTargetHelper.cs Removes now-redundant IComIID partial workaround.
src/System.Private.Windows.Core/src/Framework/Windows/Win32/UI/Shell/IDragSourceHelper2.cs Removes now-redundant IComIID partial workaround.
src/System.Private.Windows.Core/src/Framework/Windows/Win32/System/Ole/IDropTarget.cs Removes now-redundant IComIID partial workaround.
src/System.Private.Windows.Core/src/Framework/Windows/Win32/System/Com/IUnknown.cs Removes now-redundant IComIID partial workaround.
src/System.Private.Windows.Core/src/Framework/Windows/Win32/System/Com/ITypeLib.cs Removes now-redundant IComIID partial workaround.
src/System.Private.Windows.Core/src/Framework/Windows/Win32/System/Com/ITypeInfo.cs Removes now-redundant IComIID partial workaround.
src/System.Private.Windows.Core/src/Framework/Windows/Win32/System/Com/IStream.cs Removes now-redundant IComIID partial workaround.
src/System.Private.Windows.Core/src/Framework/Windows/Win32/System/Com/IGlobalInterfaceTable.cs Removes now-redundant IComIID partial workaround.
src/System.Private.Windows.Core/src/Framework/Windows/Win32/System/Com/IEnumSTATDATA.cs Removes now-redundant IComIID partial workaround.
src/System.Private.Windows.Core/src/Framework/Windows/Win32/System/Com/IEnumFORMATETC.cs Removes now-redundant IComIID partial workaround.
src/System.Private.Windows.Core/src/Framework/Windows/Win32/System/Com/IDataObject.cs Removes now-redundant IComIID partial workaround.
src/System.Private.Windows.Core/src/Framework/Windows/Win32/System/Com/IAdviseSink.cs Removes now-redundant IComIID partial workaround.
src/System.Private.Windows.Core/src/Framework/Windows/Win32/IComIID.cs Removes now-redundant manual IComIID interface.
src/System.Drawing.Common/src/System/Drawing/Printing/PageSettings.cs Updates DocumentProperties handle type to PRINTER_HANDLE.
eng/Versions.props Bumps MicrosoftWindowsCsWin32PackageVersion to 0.3.287.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread src/System.Windows.Forms/System/Windows/Forms/Help/Help.cs
@JeremyKuhne
Potential fix for pull request finding
99a8cf9 
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@JeremyKuhne JeremyKuhne enabled auto-merge (squash) June 12, 2026 22:31
@KlausLoeffelmann

KlausLoeffelmann commented Jun 12, 2026

Copy link
Copy Markdown
Member

Ah, sorry @JeremyKuhne for the delay.
I got test issues in my branches after rebasing - but I only now saw - those are here also.

Can you take a look?

@KlausLoeffelmann KlausLoeffelmann mentioned this pull request Jun 13, 2026
Open
@KlausLoeffelmann

KlausLoeffelmann commented Jun 13, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

I (Copilot.Cli) took a quick look at the failing build on behalf of Klaus.

This looks deterministic rather than intermittent: the build is failing on a syntax error in Help.cs from the GetShortPathName update:

Help.cs(191,6): error CS1513: } expected

I opened a tiny support PR against your incoming branch here: JeremyKuhne#1

That PR is meant purely as support help; no problem at all to dismiss it if it takes the wrong approach or if you already have another fix in mind.

@JeremyKuhne
Fix missing closing brace in Help.ShowHTML10Help
1ca2bc2 
The autofix that added the 'if (written > 0)' guard around the short-path assignment dropped the closing brace of the 'if (requiredStringSize > 0)' block, producing CS1513 and breaking all build legs. Restore the brace, keeping the behavioral guard.
@JeremyKuhne

JeremyKuhne commented Jun 13, 2026

Copy link
Copy Markdown
Member Author

I (Copilot.Cli) took a quick look at the failing build on behalf of Klaus.

This looks deterministic rather than intermittent: the build is failing on a syntax error in Help.cs from the GetShortPathName update:

Help.cs(191,6): error CS1513: } expected

I opened a tiny support PR against your incoming branch here: JeremyKuhne#1

That PR is meant purely as support help; no problem at all to dismiss it if it takes the wrong approach or if you already have another fix in mind.

I don't know why CoPilot messed up the brackets, I've put up a fix and it appears to be passing now.

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

Reviewers

Copilot code review Copilot Copilot left review comments

@KlausLoeffelmann KlausLoeffelmann KlausLoeffelmann requested changes

@Shyam-Gupta Shyam-Gupta Shyam-Gupta left review comments

+1 more reviewer

@jevansaks jevansaks jevansaks left review comments

Reviewers whose approvals may not affect merge requirements

Requested changes must be addressed to merge this pull request.

Assignees

@JeremyKuhne JeremyKuhne

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@JeremyKuhne @KlausLoeffelmann @jevansaks @Shyam-Gupta