Offer SafeHandle overloads of methods with HGDIOBJ parameters

Fixes #275
microsoft · Jan 10, 2024 · a71ff04 · a71ff04
1 parent efd80a7
commit a71ff04
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/src/Microsoft.Windows.CsWin32/MetadataIndex.cs b/src/Microsoft.Windows.CsWin32/MetadataIndex.cs
@@ -175,6 +175,12 @@ void PopulateNamespace(NamespaceDefinition ns, string? parentNamespace)
                                     }
                                 }
                             }
+                            else if (this.MetadataName == "Windows.Win32" && typeName == "HGDIOBJ")
+                            {
+                                // This "base type" struct doesn't have an RAIIFree attribute,
+                                // but methods that take an HGDIOBJ parameter are expected to offer SafeHandle friendly overloads.
+                                this.handleTypeReleaseMethod.Add(tdh, "DeleteObject");
+                            }
                         }
                     }
                 }

diff --git a/test/Microsoft.Windows.CsWin32.Tests/HandleTests.cs b/test/Microsoft.Windows.CsWin32.Tests/HandleTests.cs
@@ -128,6 +128,15 @@ public void HandleTypeDefsUseIntPtrAsFieldType(string handleType)
         Assert.Equal(nameof(IntPtr), Assert.IsType<IdentifierNameSyntax>(field.Declaration.Type).Identifier.ValueText);
     }
 
+    [Fact]
+    public void SafeHandleOverloadsGeneratedFor_HGDIObj()
+    {
+        this.GenerateApi("GetObject");
+        Assert.Contains(
+            this.FindGeneratedMethod("GetObject"),
+            method => method!.ParameterList.Parameters[0].Type is IdentifierNameSyntax { Identifier: { ValueText: "SafeHandle" } });
+    }
+
     [Fact]
     public void ReleaseMethodGeneratedWithHandleStruct()
     {