Write-PSMessage
SYNOPSIS
Writes the given into to screen
SYNTAX
Write-PSMessage [[-Action] <String>] [[-Severity] <String>] [[-BeforeMessage] <String[]>]
[[-BeforeMessageColor] <String[]>] [[-Object] <String[]>] [[-AfterMessage] <String[]>]
[[-AfterMessageColor] <String[]>] [[-InsertTabs] <Int32>] [[-LinesBefore] <Int32>] [[-LinesAfter] <Int32>]
[-NoNewLine] [<CommonParameters>]
DESCRIPTION
Writes the given into to screen
EXAMPLES
EXAMPLE 1
Write-PSMessage -Action Getting -Severity Information -Object (get-item .) -Message "This is","the directory","you are in." -MessageColor Cyan,DarkGreen,DarkRed
PARAMETERS
-Action
Action for the object.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Severity
Severity of the entry.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: Information
Accept pipeline input: False
Accept wildcard characters: False
-BeforeMessage
Message to display before object. This can be an array of strings as well, to have different colors in the text.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-BeforeMessageColor
The Colour of the corresponding message in the array.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Object
The object to be reported on.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-AfterMessage
Message to display after object. This can be an array of strings as well, to have different colors in the text.
Type: String[]
Parameter Sets: (All)
Aliases: Message
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-AfterMessageColor
The Colour of the corresponding message in the array.
Type: String[]
Parameter Sets: (All)
Aliases: MessageColor
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-InsertTabs
Insert tabs before writing the text.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-LinesBefore
Insert Blank Lines before Output.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-LinesAfter
Insert Blank Lines After Output.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: 10
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-NoNewLine
Wont add a new line after writing to screen.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.