microsoft / microsoft/CsWin32

SysFreeStringSafeHandle has no way of actually getting the held string value

Open
#1,393 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Is your feature request related to a problem? Please describe.
The SysFreeStringSafeHandle type provides no mechanism for actually accessing the string that it supposedly wraps.

Describe the solution you'd like
An override of the ToString() method, perhaps, or a new property or method for getting the string value.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
I'm using the QueryPathOfRegLib API, and the generated "higher level" wrapper function has an out parameter typed as a SysFreeStringSafeHandle. Also, the way that the function creates the handle and returns it as an out parameter prevents the caller from automatically freeing it with a using statement/expression.

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 with the SysFreeStringSafeHandle type and the generated higher-level QueryPathOfRegLib wrapper described in the issue. Determine how callers can access the held string and how the out parameter's lifetime is managed. Done means the API provides a usable string-access mechanism and the handle can be safely released by callers.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.