microsoft / microsoft/CsWin32

CM_Locate_DevNode does not generate friendly overload

Open
#1,710 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
C#
Stars
2.5k
Forks
123
Avg merge
1d 3h
Merged PRs (30d)
9

Description

Actual behavior

CM_Locate_DevNode does not generate Span or string overload for second parameter ([Optional] winmdroot.Foundation.PWSTR pDeviceID).

Expected behavior

Generating overloads like:
internal static extern unsafe winmdroot.Devices.DeviceAndDriverInstallation.CONFIGRET CM_Locate_DevNode(out uint pdnDevInst, [Optional] Span pDeviceID, winmdroot.Devices.DeviceAndDriverInstallation.CM_LOCATE_DEVNODE_FLAGS ulFlags);

or

internal static extern unsafe winmdroot.Devices.DeviceAndDriverInstallation.CONFIGRET CM_Locate_DevNode(out uint pdnDevInst, [Optional] string pDeviceID, winmdroot.Devices.DeviceAndDriverInstallation.CM_LOCATE_DEVNODE_FLAGS ulFlags);

Maybe this is expected behaviour. In that case, what is the best way to handle my task - passing string to this method?

Repro steps

  1. NativeMethods.txt content:
CM_Locate_DevNode
  1. NativeMethods.json content (if present):
  1. Any of your own code that should be shared?
Context
  • CsWin32 version: 0.3.275
  • Win32Metadata version (if explicitly set by project):
  • Target Framework: net10.0
  • LangVersion (if explicitly set by project): [e.g. 9]

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the generated declaration from the stated NativeMethods.txt entry for CM_Locate_DevNode, then inspect how the generator handles its optional PWSTR parameter. Done means determining whether Span or string overload generation is intended and documenting or implementing the supported way to pass the device ID.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
operating-systems, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.