Clear-Content

Deletes the contents of an item, but does not delete the item.
Clear-Content [-Path*] <String[]> [-Credential [<PSCredential>]] [-Exclude [<String[]>]] [-Filter [<String>]][-Force] [-Include [<String[]>]] [-Stream [<System.String>]] [-Confirm] [-WhatIf] [-UseTransaction[<SwitchParameter>]] [<CommonParameters>]
Clear-Content [-Credential [<PSCredential>]] [-Exclude [<String[]>]] [-Filter [<String>]] [-Force] [-Include[<String[]>]] [-Stream [<System.String>]] -LiteralPath* <String[]> [-Confirm] [-WhatIf] [-UseTransaction[<SwitchParameter>]] [<CommonParameters>]

The Clear-Content cmdlet deletes the contents of an item, such as deleting the text from a file, but it does not delete the item. As a result, the item exists, but it is empty. The Clear-Content is similar to Clear-Item, but it works on items with contents, instead of items with values.

Parameters
-Credential [<PSCredential>]

Specifies a user account that has permission to perform this action. The default is the current user.

Type a user name, such as “User01” or “Domain01User01”, or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. If you type a user name, you will be prompted for a password.

This parameter is not supported by any providers installed with Windows PowerShell.

-Exclude [<String[]>]

Specifies, as a string array, strings that this cmdlet omits from the path to the content. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as “*.txt”. Wildcards are permitted.

-Filter [<String>]

Specifies a filter in the provider’s format or language. The value of this parameter qualifies the Path parameter. The syntax of the filter, including the use of wildcards, depends on the provider. Filters are more efficient than other parameters, because the provider applies them when retrieving the objects, rather than having Windows PowerShell filter the objects after they are retrieved.

-Force [<SwitchParameter>]

Forces the command to run without asking for user confirmation.

-Include [<String[]>]

Specifies, as a string array, content that this cmdlet clears. The value of this parameter qualifies the Path parameter. Enter a path element or pattern, such as “*.txt”. Wildcards are permitted.

-LiteralPath <String[]>

Specifies the paths to the items from which content is deleted. Unlike the Path parameter, the value of LiteralPath is used exactly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotation marks tell having Windows PowerShell not to interpret any characters as escape sequences.

-Path <String[]>

Specifies the paths to the items from which content is deleted. Wildcards are permitted. The paths must be paths to items, not to containers. For example, you must specify a path to one or more files, not a path to a directory. Wildcards are permitted. This parameter is required, but the parameter name (“Path”) is optional.

-Stream [<System.String>]

Type a user name, such as “User01” or “Domain01User01”, or enter a PSCredential object, such as one generated by the Get-Credential cmdlet. If you type a user name, you will be prompted for a password.This parameter is not supported by any providers installed with Windows PowerShell.

-Confirm [<SwitchParameter>]

  • Default value is false

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

-WhatIf [<SwitchParameter>]

  • Default value is false

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.

-UseTransaction [<SwitchParameter>]

  • Default value is false

Includes the command in the active transaction. This parameter is valid only when a transaction is in progress.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs

None

You cannot pipe objects to Clear-Content.

Outputs

None

This cmdlet does not return any objects.

Examples
  1. Delete all content from a directory:
    PS C:> Clear-Content "..SmpUsers*init.txt"
    

    This command deletes all of the content from the “init.txt” files in all subdirectories of the SmpUsers directory. The files are not deleted, but they are empty.

  2. Delete content of all files with a wildcard:
    PS C:> Clear-Content -Path "*" -Filter "*.log" -Force
    

    This command deletes the contents of all files in the current directory with the “.log” file name extension, including files with the read-only attribute. The asterisk (*) in the path represents all items in the current directory. The Force parameter makes the command effective on read-only files. Using a filter to restrict the command to files with the .log file name extension instead of specifying *.log in the path makes the operation faster.

Additional Notes
 You can also refer to Clear-Content by its built-in alias, "clc". For more information, see about_Aliases.

 If you omit the Path parameter name, the value of the Path parameter must be the first parameter in the 
 command. For instance, Clear-Content c:mydir*.txt. If you include the parameter name, you can list the 
 parameters in any order.

 You can use Clear-Content with the Windows PowerShell FileSystem provider and with other providers that 
 manipulate content. To clear items that are not considered to be content, such as items managed by the Windows 
 PowerShell Certificate or Registry providers, use Clear-Item.

 The Clear-Content cmdlet is designed to work with the data exposed by any provider. To list the providers 
 available in your session, type Get-PsProvider. For more information, see about_Providers.
Related Links

Add-Content
Get-Content
Get-Item
Set-Content