CsWinRT v1.1.0

Release Notes

https://www.nuget.org/packages/Microsoft.Windows.CsWinRT/1.1.0

C#/WinRT v1.1.0 aligns with the servicing .NET December 2020 Update, which is focused on fixing bugs that were found after .NET5 GA. The runtime and Windows SDK projection assemblies from this version have been inserted into the .NET 5.0.101 SDK. For a complete list of bug-fixes, see the Release 1.1.0 Milestone.

C#/WinRT package:
https://www.nuget.org/packages/Microsoft.Windows.CsWinRT/1.1.0

.NET reference packages:
https://www.nuget.org/packages/Microsoft.Windows.SDK.NET.Ref/10.0.19041.12
https://www.nuget.org/packages/Microsoft.Windows.SDK.NET.Ref/10.0.18362.12
https://www.nuget.org/packages/Microsoft.Windows.SDK.NET.Ref/10.0.17763.12

Breaking Changes

• WinRT.Runtime.dll AssemblyVersion has been incremented to v1.1.0.0. Note that building components with the updated servicing SDK may cause versioning issues if referencing projects are on an earlier version of .NET5 (e.g., .NET5 RTM).
• Added System.Numerics.VectorExtensions static methods. (#548 )

Common Errors

If your applications target an earlier .NET SDK version than any of its dependencies, it is recommended to upgrade your .NET SDK to the latest version (.NET 5.0.101 SDK). The following errors/warnings may occur in this scenario, depending on how types are shared:

• CS1705 Compiler Error: Assembly 'AssemblyName1' uses 'WinRT.Runtime, Version=1.1.0.0, Culture=neutral, PublicKeyToken=99ea127f02d97709' which has a higher version than referenced assembly 'WinRT.Runtime' with identity 'WinRT.Runtime, Version=1.0.1.33301, Culture=neutral, PublicKeyToken=99ea127f02d97709'
• Warning MSB3277: Found conflicts between different versions of "WinRT.Runtime" that could not be resolved. These reference conflicts are listed in the build log when log verbosity is set to detailed.
• System.IO.FileLoadException: 'Could not load file or assembly 'WinRT.Runtime, Version=1.1.0.0, Culture=neutral, PublicKeyToken=99ea127f02d97709'. The located assembly's manifest definition does not match the assembly reference.

The workaround for any of these errors or warnings is to upgrade your .NET SDK to the latest version (.NET 5.0.101 SDK).

Changes:

• d9f1d21 Add vtable entry for covariant IEnumerable for WinRT types too. (#601)
• cca8f40 Update StreamOperationsImplementation (#588)
• ee1fe28 Update interop.md (#586)
• 201147b Merge pull request #593 from microsoft/ujjwalchadha/fix-ibindablevector-code-gen
• 921464c Fixed code generation issues with projecting implementation of IBindableVector
• 3a28fb4 Remove (another) WinRT.Host.Shim.dll reference
• 46ec074 Add WinRT.Host and WinRT.Host.Shim to Nuget (#582)
• 02eaf84 Update sample for net5 GA (#577)
• 66da8e1 Update to .NET 5 RTM SDK. (#579)
• dc44457 Splitting AssemblyVersion from FileVersion. (#578)
See More

• 0f8cec2 Adding Vector extensions for point and size. (#575)
• ab6a5ec Use custom marshalers when type is erased with MarshalInspectable (#568)
• 183fc48 Merge pull request #573 from microsoft/ujjwalchadha/fix-splittablemap
• ecb5672 Fixed ConstantSplittableMap's Keys and Values to return read only collections
• d00974b Merge pull request #564 from microsoft/ujjwalchadha/fix-native-to-managed-calls [ #553 ]
• 0a17d76 Merge branch 'master' into ujjwalchadha/fix-native-to-managed-calls
• cc14330 Added missing methods
• e4c16dd replacement for WindowsRuntimeMarshal.GetActivationFactory (#572)
• 58f57ac link com interop guide to readme (#571)
• bd267cd update readme doc (#541)
• c29da87 Code cleanup
• 8619e44 Undid changes not required for the fix
• 642c651 Merge branch 'master' into ujjwalchadha/fix-native-to-managed-calls
• 84baa1f Merge branch 'ujjwalchadha/test-manual-projections' into ujjwalchadha/fix-native-to-managed-calls
• 95a7e72 Show actual NuGet link (#566)
• 688c4bd COM Interop guide (#563)
• ba155f5 migrate from PackageES to ESRP CodeSign task (#565)
• 730e742 Fixed #553 and further issues in native to managed calls
• d050500 Merge pull request #559 from microsoft/fix-idictionary-clear
• 4ac4147 Merge branch 'master' into fix-idictionary-clear
• 8d6b661 fix issue with FromManaged returning an HSTRING reference, rather than allocating an HSTRING, causing crashes (#551)
• 25e2ed4 Fixing read only dictionary lookup. (#536)
• 684f321 Ensure that xamlprecompile also adds generated sources (#552)
• 5b17869 Fixed IDictionary.Clear EntryPointNotFoundException
• 28e42b9 removed cruft causing warning (#556)
• 085ff21 Added tests for collections
• a36c61e Adding tests for IBindable and IDictionary
• fab6067 ensure robustness against malformed runtime class name (#534)
• 892817e Add more tests for WindowsRuntimeBufferExtensions (#527)
• af63025 Fixed removal of dll references that report IsWinmdFile == true (#533)
• fc55163 Forget the solution extension - workaround worked before, but under a ".sln" folder (#532)
• 1027a50 workaround for VS 16.8 SolutionDir bug (#529)

This list of changes was auto generated.

CsWinRT v1.1.0-prerelease.201111.6

Changes:

• 66da8e1 Update to .NET 5 RTM SDK. (#579)
• dc44457 Splitting AssemblyVersion from FileVersion. (#578)
• 0f8cec2 Adding Vector extensions for point and size. (#575)
• ab6a5ec Use custom marshalers when type is erased with MarshalInspectable (#568)
• 183fc48 Merge pull request #573 from microsoft/ujjwalchadha/fix-splittablemap
• ecb5672 Fixed ConstantSplittableMap's Keys and Values to return read only collections
• d00974b Merge pull request #564 from microsoft/ujjwalchadha/fix-native-to-managed-calls [ #553 ]
• 0a17d76 Merge branch 'master' into ujjwalchadha/fix-native-to-managed-calls
• cc14330 Added missing methods
• e4c16dd replacement for WindowsRuntimeMarshal.GetActivationFactory (#572)
See More

• 58f57ac link com interop guide to readme (#571)
• bd267cd update readme doc (#541)
• c29da87 Code cleanup
• 8619e44 Undid changes not required for the fix
• 642c651 Merge branch 'master' into ujjwalchadha/fix-native-to-managed-calls
• 84baa1f Merge branch 'ujjwalchadha/test-manual-projections' into ujjwalchadha/fix-native-to-managed-calls
• 95a7e72 Show actual NuGet link (#566)
• 688c4bd COM Interop guide (#563)
• ba155f5 migrate from PackageES to ESRP CodeSign task (#565)
• 730e742 Fixed #553 and further issues in native to managed calls
• d050500 Merge pull request #559 from microsoft/fix-idictionary-clear
• 4ac4147 Merge branch 'master' into fix-idictionary-clear
• 8d6b661 fix issue with FromManaged returning an HSTRING reference, rather than allocating an HSTRING, causing crashes (#551)
• 25e2ed4 Fixing read only dictionary lookup. (#536)
• 684f321 Ensure that xamlprecompile also adds generated sources (#552)
• 5b17869 Fixed IDictionary.Clear EntryPointNotFoundException
• 28e42b9 removed cruft causing warning (#556)
• 085ff21 Added tests for collections
• a36c61e Adding tests for IBindable and IDictionary
• fab6067 ensure robustness against malformed runtime class name (#534)
• 892817e Add more tests for WindowsRuntimeBufferExtensions (#527)
• af63025 Fixed removal of dll references that report IsWinmdFile == true (#533)
• fc55163 Forget the solution extension - workaround worked before, but under a ".sln" folder (#532)
• 1027a50 workaround for VS 16.8 SolutionDir bug (#529)

This list of changes was auto generated.

CsWinRT v1.0.2-prerelease.201103.7

Changes:

• d050500 Merge pull request #559 from microsoft/fix-idictionary-clear
• 4ac4147 Merge branch 'master' into fix-idictionary-clear
• 8d6b661 fix issue with FromManaged returning an HSTRING reference, rather than allocating an HSTRING, causing crashes (#551)
• 5b17869 Fixed IDictionary.Clear EntryPointNotFoundException

This list of changes was auto generated.

CsWinRT v1.0.2-prerelease.201103.4

Changes:

• 25e2ed4 Fixing read only dictionary lookup. (#536)
• 684f321 Ensure that xamlprecompile also adds generated sources (#552)
• 28e42b9 removed cruft causing warning (#556)
• fab6067 ensure robustness against malformed runtime class name (#534)
• 892817e Add more tests for WindowsRuntimeBufferExtensions (#527)
• af63025 Fixed removal of dll references that report IsWinmdFile == true (#533)
• fc55163 Forget the solution extension - workaround worked before, but under a ".sln" folder (#532)
• 1027a50 workaround for VS 16.8 SolutionDir bug (#529)

This list of changes was auto generated.

CsWinRT v1.0.2-prerelease.201021.1

Release Notes

This update fixes a bug where references to DLL files were being removed by the compiler because they recorded true for being WinMD files. (#533)

Important: As this is a prerelease, it is required for any libraries using this version of CsWinRT to add a dependency on this version of the CsWinRT NuGet package. Without the added dependency, the .NET5 SDK will not resolve to the higher assembly version of WinRT.Runtime.dll (v1.0.2.3311).

Changes:

• af63025 Fixed removal of dll references that report IsWinmdFile == true (#533)
• fc55163 Forget the solution extension - workaround worked before, but under a ".sln" folder (#532)
• 1027a50 workaround for VS 16.8 SolutionDir bug (#529)

This list of changes was auto generated.

CsWinRT v1.0.1

Release Notes

https://www.nuget.org/packages/Microsoft.Windows.CsWinRT/1.0.1

C#/WinRT v1.0 is aligned with the .NET 5.0 GA Release and corresponding .NET 5.0.100 SDK. The Windows SDK projections and runtime from this version of CsWinRT are included in the .NET 5.0.100 SDK. A full list of bug-fixes and changes for this version can be found in the .NET5 GA Milestone.

C#/WinRT package:
https://www.nuget.org/packages/Microsoft.Windows.CsWinRT/1.0.1

.NET reference packages:
https://www.nuget.org/packages/Microsoft.Windows.SDK.NET.Ref/10.0.19041.10
https://www.nuget.org/packages/Microsoft.Windows.SDK.NET.Ref/10.0.18362.10
https://www.nuget.org/packages/Microsoft.Windows.SDK.NET.Ref/10.0.17763.10

Breaking Changes/Known Issues

• Calling any of the RuntimeReflectionExtension methods is likely to cause issues. The runtime type of a projected class now carries around some state information and helper methods, and should not be dynamically reflected on.
• Some WinRT types may have differences in default values when projected. This may raise issues if relying on default values. For example, Windows.Foundation.DateTime is projected to System.DateTimeOffset in C# and these types have different default values. (#285)
• The add event accessor return type has changed from System.Runtime.InteropServices.WindowsRuntime.EventRegistrationToken to void. We no longer project the System.Runtime.InteropServices.WindowsRuntime type, as it has been removed from .NET5. (#384)
• ref const projection support has been added. (#478)

Dependent Packages

The assembly versions for the .NET5 RTM SDK reference package are as follows:

• WinRT.Runtime.dll: v1.0.1.33301
• Microsoft.Windows.SDK.Net.dll: v10.0.*xxxxx*.10 (19041, 18362, and 17763 SDK versions are supported)

Note: If your applications target an earlier .NET SDK version than any of its dependencies, it is recommended to update your .NET SDK version. If you do not update your .NET SDK version and any dependencies use WinRT projected types, this may result in build or runtime errors.

Changes:

• 0329a4c Fix type marshaling. (#528)
• 5b1e5e7 Added short circuit for zero count (#526)
• 6d83992 Fix linq casts. (#524)
• cca14ad Fix capacity checks in BufferExtensions (#504)
• 0672c31 better authoring fix (#523)
• 17c7f1d fixed authoring break from vtbl optimization, disabled api tests failing on build agent (#522)
• 070e09a Merge pull request #512 from microsoft/ujjwalchadha/update-additional-projections
• 3afc9c0 Merge branch 'master' into ujjwalchadha/update-additional-projections
• 295aaa7 Fix additional classes to support netstandard
• c4663f5 Don't generate a Vftbl nested type for non-generic interfaces (.NET 5 only) (#492)

See More

• 9e066cf Merge pull request #517 from microsoft/benkuhn/api-tests
• 0f67091 Merge branch 'master' into benkuhn/api-tests
• ae43cd8 Improve handling of Windows Metadata sources, add error diagnostic (#516)
• ebef014 std::filesystem::canonical fails when running on a RAM drive (#515)
• 9680367 disabling geoloc test on build servers as well. x64-only issue only repros on build servers, has unclear cause
• 40d4144 Fix tests to contain generic path
• dd475e9 Merge branch 'master' into ujjwalchadha/update-additional-projections
• bf8b970 covering broader range of failures modes that occur based on configuration in geoloc tests
• 693f79a Merge branch 'benkuhn/api-tests' of https://github.com/microsoft/CsWinRT into benkuhn/api-tests
• 5ef7fdf allowing geolocation test to degrade gracefully in automation if service unavailable
• 1223a19 Merge branch 'master' into benkuhn/api-tests
• b45ee19 Merge pull request #518 from microsoft/benkuhn/remove-anycpu
• 6f8b23f removing unused / unsupported anycpu option for unittest project
• df2a7f3 dead code cleanup
• 79c2662 adding Windows API coverage
• f91e962 Update additional projections to use IDIC
• 5bd1891 change checks on the return type of GetRuntimeClassName to check for empty or null (#511)
• 02f5615 Make our auto generation targets compatible with source link and add source link to winrt.runtime. (#505)
• 11c5d3b Fixing authoring tests and added them to build.cmd (#501)
• 42d1760 Add Buffer Length Check in ToArray and CopyTo (#502)
• 23af004 update usage doc (#500)
• 5d10668 Fix comparison to intPtr.Zero. The current implementation is allowed by a Roslyn bug that's preserved for backcompat. (#499)
• f9e64eb Merge pull request #495 from microsoft/ujjwalchadha/345-fix-typename
• 74f41d1 Fix TypeName.Name to return full assembly qualified type name for custom c# types

This list of changes was auto generated.

CsWinRT v0.9.0.201013.2

Release Notes

https://www.nuget.org/packages/Microsoft.Windows.CsWinRT/0.9.0

This release includes the following updates:

• Fixes for scenarios where the default interface is not passed for custom projections (#470)
• Projection support for ref const (#478)
• WinRT.WeakReference has been removed for .NET5. Instead, you can use System.WeakReference. (#487)

Changes:

• 27073d6 fixed regression in casting composable types (#491)
• 382e321 Remove WinRT.WeakReference for .NET 5 (#487)
• 3bab361 Improving perf of unwrapping object (#479)
• d6d4c2e Merge pull request #489 from microsoft/fix-idictionary-add
• 74fa23b Fix add and TryGet methods for net5 IDictionary
• f2bd242 Merge pull request #484 from microsoft/ujjwalchadha/fix-system-type
• bf26455 Merge branch 'master' into ujjwalchadha/fix-system-type
• cdd2440 Update SimpleMathProjection.csproj
• 626b1b0 Fix system.type's incorrect data when projecting to itself
• b3f5e65 Angzhang/testnuget (#483)

See More

• 5ff212a ref const projection support (#478)
• fc6da71 Improving error information for cswinrt tool (#480)

This list of changes was auto generated.

CsWinRT v0.8.0.201012.1

Release Notes

https://www.nuget.org/packages/Microsoft.Windows.CsWinRT/0.8.0

This version of CsWinRT is .NET5 RC2 compatible. It includes project tooling support for component authors (#451).

Breaking Changes
Refer to this list of .NET5 RC2 breaking changes.

Changes:

• ee9038a net5-windows* tfm support and a few minor fixes (#476)
• dcd2ff4 another (hopefully last) null pointer assignment (#477)
• 533fae5 Fix stack overflow due to incorrect null _inner fix (#473) [ #464 ]
• 73a2033 fixed regression in incremental debug builds sharing generated files with release (#471)
• 41c9cc7 add fallback loop for projected app types (#468)
• 40b6cb5 propagate assignment of _inner to base classes (#464)
• 46fe22b fixed crash on function pointer refactor - setting token to null (#467)
• 45c8f6c Update readme.md

See More

• 910e32e Initial project build support - consuming projections (#451)
• cb6b649 Angzhang/breakingchange (#455)
• 02088c7 update sample readme cmdline build (#462)

This list of changes was auto generated.

CsWinRT v0.1.0.201006.1

Release Notes

Refer to this list of breaking changes for .NET5 RC2.

Other known issues include:

• MarshalInterface.FromAbi doesn't handle the case where ptr is not the default interface. (#360)
• WinUI3 performance issues (#413)
• ReadyToRun is not supported for applications using the .NET5 Windows 10 TFM. These applications should install the latest .NET5 SDK from the RTM branch to get the fix. (#442)
• Projected XAML classes still require an explicit registration in the app startup path. This will be fixed in the RTM release. (#465)

Changes:

• 73299a3 Angzhang/flattensample (#453)
• b8b2ea7 Merge pull request #452 from microsoft/ujjwalchadha/optimize-noexcept
• 4f86482 Add optimization for noexcept methods and test cases
• 48fd923 User/jlarkin/fixasynctests (#450)
• 1745600 adding sample files (#425)
• 8334dc6 Merge pull request #448 from microsoft/ujjwalchadha/fix-redundant-checks-codewriters
• cac5a23 Update testwinrt and clean up redundant code
• 7a5eb27 add a lock around ComWrappers singleton accessors for thread safety (unit tests occasionally failed) (#447)
• a2689f8 always create global.json and prerelease targets files on every build (#441)
• 52fedba Fix XAML app break in protected constructor from Dynamic interface castable changes. (#445)

See More

• 7b18250 Fixed broken tests, bad merge, regression in RC guid calculation (ProjectedRuntimeClass attrib), and made vector view GRCN more reliable (#444)
• 17687ff Merge pull request #369 from microsoft/IDynamicInterfaceCastable
• b06d2d3 Fix authoring
• 1f35673 skip buffer and stream async tests (#440)
• 94294d2 Fix build errors
• 80ccff5 Merge branch 'master' into IDynamicInterfaceCastable
• 4418c1b Merged Master into IDynamicInterfaceCastable
• a7748a9 transform use of await to use Tasks and waits (#439)
• 1cb8c01 Add tests for IDynamicInterfaceCastable
• e57b67c Fix casing. (#435)
• ba117da Code cleanup
• 557df57 fixed build break (#434)
• 2a947c4 IXamlServiceProvider projection (#433)
• 2fe4e76 Upgrade Authoring source generator to use new Roslyn API. (#432)
• 3831edd Update the Microsoft.NET.Compilers.Toolset package to have Roslyn respect UnmanagedCallersOnly (#427)
• 73a30a6 Merge pull request #422 from microsoft/user/jlarkin/update-IBufferByteAccess
• f7d3740 Merge branch 'master' into user/jlarkin/update-IBufferByteAccess
• 8f673c2 add unit test covering issue 359, add attribute to IMarshal
• 471979e Added manual type mappings for IDynamicInterfaceCastable
• 3686f7d INotifyDataErrorInfo implementation (#419)
• 224ee35 add support for non-void event delegates (#418)
• 290e744 Fix build. (#423)
• 3c9e700 move one of huo test out of net5 tests, fix repro test
• 2d822d6 Merge branch 'master' into user/jlarkin/update-IBufferByteAccess
• d177995 Authoring part 2 (#416)
• fca2c7b Merge branch 'master' into user/jlarkin/update-IBufferByteAccess
• b8a4d4a add contract to ibufferbyteaccess and a unittest based on repro from issue
• 64f3e35 add key and key property (#420)
• 2614a13 remove namespace rename (#414)
• be45606 Register projections with module initializers (#404)
• c38b4a2 Add field access optimization for default interfaces
• 9190ef4 [DO NOT MERGE] Restore "Update to .NET 5 Preview 8 and update compiler toolset package" (#400) [ #388, #399 ]
• 229fead Merge remote-tracking branch 'origin' into IDynamicInterfaceCastable
• f8637d1 Update .gitignore
• 1c5bdfa Adding source generator to nuget package. (#403)
• 26b5f1c demonstrate iinspectable-based interop interface (#393)
• 598ec08 Revert "Update to .NET 5 Preview 8 and update compiler toolset package (#388)" (#399)
• 63abd75 Update to .NET 5 Preview 8 and update compiler toolset package (#388)
• e9747d2 Various winmd writer fixes and adding more custom attributes (#391)
• fde97d2 Initial WinRT.Host.dll implementation (#374)
• 048a87a Update README.md (#392)
• ac42ed4 Add diagnostics to winmd reference workarounds (#387)
• efe1842 Project static As<> casting methods for access to factories for interops, etc (#385)
• 0a22529 Adding WinMD generator (#383)
• 6d6b3f0 a few gaps in authoring support (#386)
• 95cc5ee track source metadata for authoring projections (#378)
• 0076251 fixed buffer overrun with tpm switch help (#375)
• bb87934 Changes to readme, additional md files/diagram (#368)
• e86f00b Update README.md
• 597a024 Add support for IDynamicInterfaceCastable-based interfaces in RCW creation
• b5c3c31 Cache cast results in .NET 5 projection to regain some perf losses.
• a02a72c Fix more collections so the Windows projection also builds.
• b58f37d Get WinUI projection compiling with no new warnings.
• 25e4e4b Use Spans instead of LINQ to improve perf in Guid generation (startup perf).
• 1f4d869 Fix projected required interface implementations and handle default interfaces of runtime classes such that they can live in different projections and compile with only the public contract exposed.
• 1f2efee Update to LangVersion preview
• cc30448 Implement static interface support by using dynamic casting under the hood via an internal IInspectable instance.
• bcaf88e Use equality functions instead of ThisPtr.
• 6511ae6 Move activation/composition to work with IDynamicInterfaceCastable.
• 89a83ee Use the QI cache when checking if an interface is implemented.
• 4fd093b Move statics and factory caches to the IDynamicInterfaceCastable plan.
• 686cead Add fallback for when an interface is kept alive but its Vftbl type was linked away since no members on the interface were called.
• 6e455f3 Implement IDynamicInterfaceCastable for generated code excluding factories and FromAbi.
• 58c590a Add IWinRTObject interface and continue implementing the updates to interfaces.
• 7ad98c8 Start refactoring for implementing IDynamicInterfaceCastable.
• 4be3620 Don't ship the netstandard2.0 projection support.
• 11fcbd9 Don't directly use the underlying ObjectReference as the marshaler when marshalling ABI interface types. (#365)
• 4819103 Merge pull request #350 from microsoft/fnptrs
• 762e779 Update usage readme
• b0cdf20 Simplify IUnknownVftbl creation. fixes WinUIDesktopSample startup.
• 5063e20 Merge pull request #363 from microsoft/manodasanw/fnptrs-compilertools
• e41cb2e Address PR feedback.
• 05c4fb1 Updating compiler tools to support function ptrs without VS preview
• a4c9dad Merge pull request #361 from microsoft/manodasanw/dotnetupgrade
• c81f9a3 Upgrading dotnet version to released preview 7 and attempting new fix to winmd references as it regressed.
• 86ac082 Merge pull request #353 from microsoft/ujjwalchadha/benchmarks
• 7e2f90a Merge pull request #357 from microsoft/manodasanw/stringablefix
• a497f97 Merge pull request #356 from microsoft/manodasanw/lazyinterfacesfix
• 1f21ba0 Slim down native->managed vtable creation when the type is non-generic.
• 631bb36 Fix IS...