microsoft/Terminal

Documentation of use of ConPTY together with STARTF_USESTDHANDLES is lacking.

Open

#4,585 opened on Feb 14, 2020

View on GitHub
 (2 comments) (2 reactions) (0 assignees)C++ (3,212 forks)batch import
Area-ServerHelp WantedIssue-DocsProduct-Conpty

Repository metrics

Stars
 (35,764 stars)
PR merge metrics
 (Avg merge 27d 19h) (24 merged PRs in 30d)

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

Research direction
Locate the ConPTY documentation in the repository and add a note about the interaction with STARTF USESTDHANDLES, specifically that hStdInput etc. should be NULL when using that flag.
Tech stack
None
Domain
documentationapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Windows APIConPTY
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60