Share via

Stop-Transcript

  • Article

Applies To: Windows PowerShell 2.0

Stops a transcript.

Syntax

Stop-Transcript [<CommonParameters>]

Description

The Stop-Transcript cmdlet stops a transcript that was started by using the Start-Transcript cmdlet. You can also stop a transcript by ending the session.

Parameters

<CommonParameters>

This command supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, OutBuffer, OutVariable, WarningAction, and WarningVariable. For more information, see about_CommonParameters.

Inputs and Outputs

The input type is the type of the objects that you can pipe to the cmdlet. The return type is the type of the objects that the cmdlet returns.

Inputs

None

You cannot pipe input to this cmdlet.

Outputs

System.String

Stop-Transcript returns a string that contains a status message and the path to the output file.

Notes

If a transcript has not been started, the command fails.

Example 1

C:\PS>stop-transcript

Description

-----------

This command stops any running transcripts.

See Also

Concepts

Start-Transcript