Skip to content

Conversation

@dependabot
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Nov 3, 2025

Updated Microsoft.Windows.CsWin32 from 0.3.183 to 0.3.238.

Release notes

Sourced from Microsoft.Windows.CsWin32's releases.

0.3.238

Changes:

  • #​1520: Don't make void* params Span in friendly methods
  • #​1517: CsWin32Generator should allow newer language versions

This list of changes was auto generated.

0.3.236

NOTE: This changes the signature of methods with optional parameters. This change is also documented at https://microsoft.github.io/CsWin32/docs/getting-started.html:

Optional out/ref parameters

Some parameters in win32 are [optional, out] or [optional, in, out]. C# does not have an idiomatic way to represent this concept, so for any method that has such parameters, CsWin32 will generate two versions: one with all ref or out parameters included, and one with all such parameters omitted. For example:

// Omitting the optional parameter:
IsTextUnicode(buffer);

// Passing ref for optional parameter:
IS_TEXT_UNICODE_RESULT result = default;
IsTextUnicode(buffer, ref result);

Working with Span-typed and MemorySize-d parameters

In the Win32 APIs there are many functions where one parameter is a buffer (void* or byte*) and another parameter is the size of that buffer. When generating for a target framework that supports Spans, there will be overloads of these functions that take a Span<byte> which represents both of these parameters, since a Span refers to a chunk of memory and a length. For example, an API like IsTextUnicode has a void* parameter whose length is described by the iSize parameter in the native signature. The CsWin32 projection of this method will be:

BOOL IsTextUnicode(ReadOnlySpan<byte> lpv, ref IS_TEXT_UNICODE_RESULT lpiResult)

Instead of passing the buffer and length separately, in this projection you pass just one parameter. Span is a flexible type with many things that can be converted to it safely. You will also see Span parameters for things that may look like a struct but are variable sized. For example, InitializeAcl looks like it returns an ACL struct but the parameter is annotated with a [MemorySize] attribute in the metadata, indicating it is variable-sized based on another parameter. Thus, the cswin32 projection of this method will project this parameter as a Span<byte> since the size of the parameter is variable:

// The cswin32 signature:
static BOOL InitializeAcl(Span<byte> pAcl, ACE_REVISION dwAclRevision) { ... }

And you would call this by creating a buffer to receive the ACL. Then, after the call you can reinterpret the buffer as an ACL:

// Make a buffer
Span<byte> buffer = new byte[CalculateAclSize(...)];
InitializeAcl(buffer, ACE_REVISION.ACL_REVISION);

// The beginning of the buffer is an ACL, so cast it to a ref:
ref ACL acl = ref MemoryMarshal.AsRef<ACL>(buffer);

// Or treat it as a Span:
Span<ACL> aclSpan = MemoryMarshal.Cast<byte, ACL>(buffer);

CsWin32 will also generate a struct-typed parameter for convenience but this overload will pass sizeof(T) for the length parameter to the underlying Win32 API, so this only makes sense in some overloads such as SHGetFileInfo where the parameter has an annotation indicating it's variable-sized, but the size is only ever sizeof(SHFILEINFOW):

// Span<byte> overload:
static nuint SHGetFileInfo(string pszPath, FILE_FLAGS_AND_ATTRIBUTES dwFileAttributes, Span<byte> psfi, SHGFI_FLAGS uFlags)
// ref SHGETFILEINFOW overload:
static nuint SHGetFileInfo(string pszPath, FILE_FLAGS_AND_ATTRIBUTES dwFileAttributes, ref SHFILEINFOW psfi, SHGFI_FLAGS uFlags)
 ... (truncated)

## 0.3.235

## What's Changed
* Handle CoCreateable classes in ComSourceGenerators mode by @​jevansaks in https://github.com/microsoft/CsWin32/pull/1502
* Simplify decimal conversions by @​jevansaks in https://github.com/microsoft/CsWin32/pull/1512
* Prevent SafeHandle from being re-generated in downstream assembly by @​jevansaks in https://github.com/microsoft/CsWin32/pull/1514
* Fix ArithmeticOverflow in HANDLE types and other helpers when CheckForOverflowUnderflow is enabled by @​jevansaks in https://github.com/microsoft/CsWin32/pull/1513

**Full Changelog**: https://github.com/microsoft/CsWin32/compare/v0.3.228...v0.3.235

## 0.3.228

## What's Changed
* BuildTask mode should not generate types from InternalsVisibleTo referenced assemblies by @​jevansaks in https://github.com/microsoft/CsWin32/pull/1492
* CsWin32 build task fixes for NET8/CSharp12 by @​jevansaks in https://github.com/microsoft/CsWin32/pull/1498
* Fix platform case sensitivity issue with CsWin32Generator tool by @​jevansaks in https://github.com/microsoft/CsWin32/pull/1499
* Update documentation for CsWin32RunAsBuildTask mode by @​jevansaks in https://github.com/microsoft/CsWin32/pull/1497
* ArrayPool can be larger than requested resulting in freeing uninitialized GCHandles by @​jlaanstra in https://github.com/microsoft/CsWin32/pull/1405
* Fix analyzer test break in devdiv AzDO account by @​AArnott in https://github.com/microsoft/CsWin32/pull/1504

## New Contributors
* @​jlaanstra made their first contribution in https://github.com/microsoft/CsWin32/pull/1405

**Full Changelog**: https://github.com/microsoft/CsWin32/compare/v0.3.217...v0.3.228

https://www.nuget.org/packages/Microsoft.Windows.CsWin32/0.3.228

## 0.3.217

## What's Changed
* Add cswin32 mode to generate [GeneratedComInterface] and [LibraryImport] code by @​jevansaks in https://github.com/microsoft/CsWin32/pull/1474
* Handle UnauthorizedAccessException in new ComTests by @​jevansaks in https://github.com/microsoft/CsWin32/pull/1486
* Project byte* parameters as Span<byte> by @​jevansaks in https://github.com/microsoft/CsWin32/pull/1488
* Fix nuspec to refer to only signed files and drop apphost.exe from the nuget by @​jevansaks in https://github.com/microsoft/CsWin32/pull/1489


**Full Changelog**: https://github.com/microsoft/CsWin32/compare/v0.3.213...v0.3.217

## 0.3.213

## What's Changed
* Retarget to roslyn for VS 2022 Update 14 by @​AArnott in https://github.com/microsoft/CsWin32/pull/1466
* .NET targeting projects should reference `Microsoft.Windows.SDK.NET.Ref` instead by @​AArnott in https://github.com/microsoft/CsWin32/pull/1471
* Update win32metadata version to 65.0.8-preview by @​jevansaks in https://github.com/microsoft/CsWin32/pull/1469
* Update dependency Microsoft.Build.NoTargets to 3.7.134 by @​renovate[bot] in https://github.com/microsoft/CsWin32/pull/1461


**Full Changelog**: https://github.com/microsoft/CsWin32/compare/v0.3.205...v0.3.213

## 0.3.205

## What's Changed
* Add msbuild item to opt 3rd party libraries into app-local deployments by @​AArnott in https://github.com/microsoft/CsWin32/pull/1381
* Fix NRE thrown from friendly overloads with optional pointer parameters by @​AArnott in https://github.com/microsoft/CsWin32/pull/1385
* Update getting-started.md by @​LWChris in https://github.com/microsoft/CsWin32/pull/1388
* Remove test workaround by @​DoctorKrolic in https://github.com/microsoft/CsWin32/pull/1447
* Add custom DebuggerDisplay for HRESULT by @​misaz in https://github.com/microsoft/CsWin32/pull/1445
* Update documentation links from `docs.microsoft.com` to `learn.microsoft.com` by @​xtqqczze in https://github.com/microsoft/CsWin32/pull/1454
* Merge latest Library.Template by @​AArnott in https://github.com/microsoft/CsWin32/pull/1458
* Support for derived IInspectable COM interfaces in custom winmds by @​jevansaks in https://github.com/microsoft/CsWin32/pull/1459

## New Contributors
* @​LWChris made their first contribution in https://github.com/microsoft/CsWin32/pull/1388
* @​DoctorKrolic made their first contribution in https://github.com/microsoft/CsWin32/pull/1447
* @​misaz made their first contribution in https://github.com/microsoft/CsWin32/pull/1445
* @​xtqqczze made their first contribution in https://github.com/microsoft/CsWin32/pull/1454

**Full Changelog**: https://github.com/microsoft/CsWin32/compare/v0.3.183...v0.3.205

Commits viewable in [compare view](https://github.com/microsoft/CsWin32/compare/v0.3.183...v0.3.238).
</details>

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=Microsoft.Windows.CsWin32&package-manager=nuget&previous-version=0.3.183&new-version=0.3.238)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)


</details>

---
updated-dependencies:
- dependency-name: Microsoft.Windows.CsWin32
  dependency-version: 0.3.238
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added .NET Pull requests that update .NET code dependencies Pull requests that update a dependency file labels Nov 3, 2025
@dependabot @github
Copy link
Contributor Author

dependabot bot commented on behalf of github Nov 4, 2025

Superseded by #34.

@dependabot dependabot bot closed this Nov 4, 2025
@dependabot dependabot bot deleted the dependabot/nuget/Microsoft.Windows.CsWin32-0.3.238 branch November 4, 2025 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file .NET Pull requests that update .NET code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant