Edit

Share via

Stop-Transcript

  • Reference
Module:
Microsoft.PowerShell.Host

Stops a transcript.

Syntax

Stop-Transcript
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Stop-Transcript cmdlet stops a transcript that was started by the Start-Transcript cmdlet. Alternatively, you can end a session to stop a transcript.

Examples

Example 1: Stop all transcripts

Stop-Transcript

This command stops all transcripts.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

This parameter was added in PowerShell 7.4.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet isn't run.

This parameter was added in PowerShell 7.4.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

You can't pipe objects to this cmdlet.

Outputs

String

This cmdlet returns a string that contains a status message and the path to the output file.

Notes

If a transcript hasn't been started, the command fails.