microsoft / microsoft/terminal

Documentation of use of ConPTY together with STARTF_USESTDHANDLES is lacking.

Open
#4,585 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area-Server Help Wanted Issue-Docs Product-Conpty
Dominant language
C++
Stars
105k
Forks
9.6k
Avg merge
3d 17h
Merged PRs (30d)
29

Description

All existing documentation of ConPTY seem to only mention the case where stdin, stdout and stderr are all to be connected to the pty and no STARTF_USESTDHANDLES. The only mention that the proper value to have in StartupInfo.hStdInput et al when STARTF_USESTDHANDLES is active is NULL is indirectly in the documentation for GetStdHandle().

Using STARTF_USESTDHANDLES is useful if you want to keep stdout and stderr separate or want to redirect one of them to eg a file.

An explicit mention in conjunction with STARTUPINFOA and/or PROC_THREAD_ATTRIBUTE_PSEUDOCONSOLE would be appreciated.

Thanks.

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 reviewing the existing ConPTY documentation and the GetStdHandle documentation, then compare the guidance for STARTUPINFOA and PROC_THREAD_ATTRIBUTE_PSEUDOCONSOLE. Done means the documentation explicitly explains the NULL hStdInput, hStdOutput, and hStdError values when STARTF_USESTDHANDLES is active, including cases that keep streams separate or redirect one to a file.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
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.