powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Clear-History



NAME
Clear-History

SYNOPSIS
Deletes entries from the command history.

SYNTAX
Clear-History [[-Id] ] [[-Count] ] [-Newest] [-Confirm] [-WhatIf] []

Clear-History [[-Count] ] [-CommandLine ] [-Newest] [-Confirm] [-WhatIf] []


DESCRIPTION
The Clear-History cmdlet deletes commands from the command history, that is, the list of commands entered during th
e current session.

Without parameters, Clear-History deletes all commands from the session history, but you can use the parameters of
Clear-History to delete selected commands.


PARAMETERS
-CommandLine
Deletes commands with the specified text strings. If you enter more than one string, Clear-History deletes comm
ands with any of the strings.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-Count
Clears the specified number of history entries, beginning with the oldest entry in the history.

If you use the Count and Id parameters in the same command, the cmdlet clears the number of entries specified b
y the Count parameter, beginning with the entry specified by the Id parameter. For example, if Count is 10 and
Id is 30, Clear-History clears items 21 through 30 inclusive.

If you use the Count and CommandLine parameters in the same command, Clear-History clears the number of entries
specified by the Count parameter, beginning with the entry specified by the CommandLine parameter.

Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Id
Deletes commands with the specified history IDs.

To find the history ID of a command, use Get-History.

Required? false
Position? 1
Default value None
Accept pipeline input? false
Accept wildcard characters? false

-Newest []
Deletes the newest entries in the history. By default, Clear-History deletes the oldest entries in the history.

Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false

-Confirm []
Prompts you for confirmation before executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-WhatIf []
Describes what would happen if you executed the command without actually executing the command.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS
None
You cannot pipe objects to Clear-History.


OUTPUTS
None
This cmdlet does not generate any output.


NOTES


The session history is a list of the commands entered during the session. You can view the history, add and del
ete commands, and run commands from the history. For more information, see about_History.

Deleting a command from the history does not change the history IDs of the remaining items in the command histo
ry.


-------------------------- EXAMPLE 1 --------------------------

C:\PS>clear-history


Description
-----------
Deletes all commands from the session history.





-------------------------- EXAMPLE 2 --------------------------

C:\PS>clear-history -id 23, 25


Description
-----------
Deletes the commands with history IDs 23 and 25.





-------------------------- EXAMPLE 3 --------------------------

C:\PS>clear-history -command *help*, *command


Description
-----------
Deletes commands that include "help" or end in "command".





-------------------------- EXAMPLE 4 --------------------------

C:\PS>clear-history -count 10 -newest


Description
-----------
Deletes the 10 newest commands from the history.





-------------------------- EXAMPLE 5 --------------------------

C:\PS>clear-history -id 10 -count 3


Description
-----------
Deletes the three oldest commands, beginning with the entry with ID 10.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=135199
about_History
Get-History
Add-History
Invoke-History