Skip to content

Fixes #11654 - Fix typos and add links for PSConsoleHostReadline #11657

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 10, 2025
Merged

Fixes #11654 - Fix typos and add links for PSConsoleHostReadline #11657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 23 additions & 22 deletions reference/5.1/Microsoft.PowerShell.Core/About/about_PSConsoleHostReadLine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,33 +1,31 @@
---
description: Explains how to create a customize how PowerShell reads input at the console prompt.
description: Explains how to customize how PowerShell reads input at the console prompt.
Locale: en-US
ms.date: 01/04/2018
ms.date: 01/09/2025
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_psconsolehostreadline?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about_PSConsoleHostReadLine
---

# about_PSConsoleHostReadLine

## Short description

Explains how to create a customize how PowerShell reads input at the console
prompt.
Explains how to customize how PowerShell reads input at the console prompt.

## Long description

Starting in Windows PowerShell V3, you can write a function named
PSConsoleHostReadLine that overrides the default way that console input is
Starting in Windows PowerShell 3.0, you can write a function named
`PSConsoleHostReadLine` that overrides the default way that console input is
processed.

### EXAMPLES
This function is extended by the **PSReadLine** module.

The following example launches Notepad and gets input from a text File that
### Examples

The following example launches Notepad and gets input from a text file that
the user creates:

```powershell
function PSConsoleHostReadLine
{
function PSConsoleHostReadLine {
$inputFile = Join-Path $env:TEMP PSConsoleHostReadLine
Set-Content $inputFile "PS > "

Expand All @@ -39,18 +37,21 @@ function PSConsoleHostReadLine
}
```

### REMARKS

By default, PowerShell reads input from the console in what is known as
"Cooked Mode" -- in which the Windows console subsystem handles all the
keypresses, F7 menus, and other input. When you press Enter or Tab, Windows
PowerShell gets the text that you have typed up to that point. There is no way
for it to know that you pressed Ctrl-R, Ctrl-A, Ctrl-E, or any other keys
before pressing Enter or Tab. In Windows PowerShell version 3, the
PSConsoleHostReadLine function solves this issue. When you define a function
named PSConsoleHostReadline in the Windows PowerShell console host, Windows
### Remarks

By default, PowerShell reads input from the console in what is known as "Cooked
Mode" -- in which the Windows console subsystem handles all the keypresses,
<kbd>F7</kbd> menus, and other input. When you press <kbd>Enter</kbd> or
<kbd>Tab</kbd>, PowerShell gets the text that you have typed up to that point.
There is no way for it to know that you pressed <kbd>Ctrl</kbd>+<kbd>R</kbd>,
<kbd>Ctrl</kbd>+<kbd>A</kbd>, <kbd>Ctrl</kbd>+<kbd>E</kbd>, or any other keys
before pressing <kbd>Enter</kbd> or <kbd>Tab</kbd>. In Windows PowerShell 3.0,
the `PSConsoleHostReadLine` function solves this issue. When you define a
function named `PSConsoleHostReadline` in the PowerShell console host,
PowerShell calls that function instead of the "Cooked Mode" input mechanism.

## See Also

- [about_Prompts](about_Prompts.md)
- [PSConsoleHostReadLine](/powershell/module/psreadline/psconsolehostreadline)
- [High-Level Console Modes](/windows/console/high-level-console-modes)
2 changes: 1 addition & 1 deletion reference/5.1/PSReadLine/PSConsoleHostReadLine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: PSReadLine-help.xml
Locale: en-US
Module Name: PSReadLine
ms.date: 06/27/2024
ms.date: 01/09/2025
online version: https://learn.microsoft.com/powershell/module/psreadline/psconsolehostreadline?view=powershell-5.1&WT.mc_id=ps-gethelp
schema: 2.0.0
title: PSConsoleHostReadLine
Expand Down
39 changes: 21 additions & 18 deletions reference/7.4/Microsoft.PowerShell.Core/About/about_PSConsoleHostReadLine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
---
description: Explains how to create a customize how PowerShell reads input at the console prompt.
description: Explains how to customize how PowerShell reads input at the console prompt.
Locale: en-US
ms.date: 01/04/2018
ms.date: 01/09/2025
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_psconsolehostreadline?view=powershell-7.4&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about_PSConsoleHostReadLine
---
# about_PSConsoleHostReadLine

## Short description
Explains how to create a customize how PowerShell reads input at the console
prompt.
Explains how to customize how PowerShell reads input at the console prompt.

## Long description

Starting in Windows PowerShell 3.0, you can write a function named
PSConsoleHostReadLine that overrides the default way that console input is
`PSConsoleHostReadLine` that overrides the default way that console input is
processed.

### EXAMPLES
This function is extended by the **PSReadLine** module.

The following example launches Notepad and gets input from a text File that
### Examples

The following example launches Notepad and gets input from a text file that
the user creates:

```powershell
function PSConsoleHostReadLine
{
function PSConsoleHostReadLine {
$inputFile = Join-Path $env:TEMP PSConsoleHostReadLine
Set-Content $inputFile "PS > "

Expand All @@ -37,18 +37,21 @@ function PSConsoleHostReadLine
}
```

### REMARKS
### Remarks

By default, PowerShell reads input from the console in what is known as "Cooked
Mode" -- in which the Windows console subsystem handles all the keypresses, F7
menus, and other input. When you press Enter or Tab, PowerShell gets the text
that you have typed up to that point. There is no way for it to know that you
pressed Ctrl-R, Ctrl-A, Ctrl-E, or any other keys before pressing Enter or Tab.
In Windows PowerShell 3.0, the PSConsoleHostReadLine function solves this
issue. When you define a function named PSConsoleHostReadline in the PowerShell
console host, PowerShell calls that function instead of the "Cooked Mode" input
mechanism.
Mode" -- in which the Windows console subsystem handles all the keypresses,
<kbd>F7</kbd> menus, and other input. When you press <kbd>Enter</kbd> or
<kbd>Tab</kbd>, PowerShell gets the text that you have typed up to that point.
There is no way for it to know that you pressed <kbd>Ctrl</kbd>+<kbd>R</kbd>,
<kbd>Ctrl</kbd>+<kbd>A</kbd>, <kbd>Ctrl</kbd>+<kbd>E</kbd>, or any other keys
before pressing <kbd>Enter</kbd> or <kbd>Tab</kbd>. In Windows PowerShell 3.0,
the `PSConsoleHostReadLine` function solves this issue. When you define a
function named `PSConsoleHostReadline` in the PowerShell console host,
PowerShell calls that function instead of the "Cooked Mode" input mechanism.

## See Also

- [about_Prompts](about_Prompts.md)
- [PSConsoleHostReadLine](/powershell/module/psreadline/psconsolehostreadline)
- [High-Level Console Modes](/windows/console/high-level-console-modes)
2 changes: 1 addition & 1 deletion reference/7.4/PSReadLine/PSConsoleHostReadLine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: PSReadLine-help.xml
Locale: en-US
Module Name: PSReadLine
ms.date: 06/27/2024
ms.date: 01/09/2025
online version: https://learn.microsoft.com/powershell/module/psreadline/psconsolehostreadline?view=powershell-7.4&WT.mc_id=ps-gethelp
schema: 2.0.0
title: PSConsoleHostReadLine
Expand Down
40 changes: 21 additions & 19 deletions reference/7.5/Microsoft.PowerShell.Core/About/about_PSConsoleHostReadLine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,31 @@
---
description: Explains how to create a customize how PowerShell reads input at the console prompt.
description: Explains how to customize how PowerShell reads input at the console prompt.
Locale: en-US
ms.date: 01/04/2018
ms.date: 01/09/2025
online version: https://learn.microsoft.com/powershell/module/microsoft.powershell.core/about/about_psconsolehostreadline?view=powershell-7.5&WT.mc_id=ps-gethelp
schema: 2.0.0
title: about_PSConsoleHostReadLine
---
# about_PSConsoleHostReadLine

## Short description

Explains how to create a customize how PowerShell reads input at the console
prompt.
Explains how to customize how PowerShell reads input at the console prompt.

## Long description

Starting in Windows PowerShell 3.0, you can write a function named
PSConsoleHostReadLine that overrides the default way that console input is
`PSConsoleHostReadLine` that overrides the default way that console input is
processed.

### EXAMPLES
This function is extended by the **PSReadLine** module.

### Examples

The following example launches Notepad and gets input from a text File that
The following example launches Notepad and gets input from a text file that
the user creates:

```powershell
function PSConsoleHostReadLine
{
function PSConsoleHostReadLine {
$inputFile = Join-Path $env:TEMP PSConsoleHostReadLine
Set-Content $inputFile "PS > "

Expand All @@ -38,18 +37,21 @@ function PSConsoleHostReadLine
}
```

### REMARKS
### Remarks

By default, PowerShell reads input from the console in what is known as "Cooked
Mode" -- in which the Windows console subsystem handles all the keypresses, F7
menus, and other input. When you press Enter or Tab, PowerShell gets the text
that you have typed up to that point. There is no way for it to know that you
pressed Ctrl-R, Ctrl-A, Ctrl-E, or any other keys before pressing Enter or Tab.
In Windows PowerShell 3.0, the PSConsoleHostReadLine function solves this
issue. When you define a function named PSConsoleHostReadline in the PowerShell
console host, PowerShell calls that function instead of the "Cooked Mode" input
mechanism.
Mode" -- in which the Windows console subsystem handles all the keypresses,
<kbd>F7</kbd> menus, and other input. When you press <kbd>Enter</kbd> or
<kbd>Tab</kbd>, PowerShell gets the text that you have typed up to that point.
There is no way for it to know that you pressed <kbd>Ctrl</kbd>+<kbd>R</kbd>,
<kbd>Ctrl</kbd>+<kbd>A</kbd>, <kbd>Ctrl</kbd>+<kbd>E</kbd>, or any other keys
before pressing <kbd>Enter</kbd> or <kbd>Tab</kbd>. In Windows PowerShell 3.0,
the `PSConsoleHostReadLine` function solves this issue. When you define a
function named `PSConsoleHostReadline` in the PowerShell console host,
PowerShell calls that function instead of the "Cooked Mode" input mechanism.

## See Also

- [about_Prompts](about_Prompts.md)
- [PSConsoleHostReadLine](/powershell/module/psreadline/psconsolehostreadline)
- [High-Level Console Modes](/windows/console/high-level-console-modes)
2 changes: 1 addition & 1 deletion reference/7.5/PSReadLine/PSConsoleHostReadLine.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
external help file: PSReadLine-help.xml
Locale: en-US
Module Name: PSReadLine
ms.date: 06/27/2024
ms.date: 01/09/2025
online version: https://learn.microsoft.com/powershell/module/psreadline/psconsolehostreadline?view=powershell-7.5&WT.mc_id=ps-gethelp
schema: 2.0.0
title: PSConsoleHostReadLine
Expand Down