PowerShell/docs/write-red.md
2024-03-27 17:36:59 +01:00

67 lines
1.4 KiB
Markdown

Script: *write-red.ps1*
========================
This PowerShell script writes text in a red foreground color.
Parameters
----------
```powershell
PS> ./write-red.ps1 [[-text] <String>] [<CommonParameters>]
-text <String>
Specifies the text to write
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
Example
-------
```powershell
PS> ./write-red "Hello World"
```
Notes
-----
Author: Markus Fleschutz | License: CC0
Related Links
-------------
https://github.com/fleschutz/PowerShell
Script Content
--------------
```powershell
<#
.SYNOPSIS
Writes text in a red foreground color
.DESCRIPTION
This PowerShell script writes text in a red foreground color.
.PARAMETER text
Specifies the text to write
.EXAMPLE
PS> ./write-red "Hello World"
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$text = "")
if ($text -eq "" ) { $text = read-host "Enter the text to write" }
write-host -foregroundcolor red "$text"
exit 0 # success
```
*(generated by convert-ps2md.ps1 using the comment-based help of write-red.ps1 as of 03/27/2024 17:36:33)*