| external help file | Microsoft.PowerShell.ConsoleHost.dll-Help.xml |
|---|---|
| Locale | en-US |
| Module Name | Microsoft.PowerShell.Host |
| ms.date | 01/04/2024 |
| online version | https://learn.microsoft.com/powershell/module/microsoft.powershell.host/stop-transcript?view=powershell-7.6&WT.mc_id=ps-gethelp |
| schema | 2.0.0 |
| title | Stop-Transcript |
Stops a transcript.
Stop-Transcript [-WhatIf] [-Confirm] [<CommonParameters>]
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.
Stop-TranscriptThis command stops all transcripts.
Prompts you for confirmation before running the cmdlet.
This parameter was added in PowerShell 7.4.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseShows what would happen if the cmdlet runs. The cmdlet isn't run.
This parameter was added in PowerShell 7.4.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
You can't pipe objects to this cmdlet.
This cmdlet returns a string that contains a status message and the path to the output file.
If a transcript hasn't been started, the command fails.