microsoft / microsoft/CsWin32

Friendly overloads should translate `out PCWSTR` to `out string`

Open
#138 2 comments 1 reaction 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

In process of doing this, keep @kennykerr's advice in mind:

If there's no attribute that says how to free the PWSTR then you let the API free it and you simply copy the string. IXmlReader is an example of this. If there's an attribute that indicates how to free the memory then you use that allocator. ISpellingError is an example of this.

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 locating the friendly overload generation for Win32 methods that expose out PCWSTR values. Use the IXmlReader and ISpellingError examples from the issue to understand when strings are copied or freed with an indicated allocator; done means the generated overload exposes out string with the correct memory-management behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.