powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-Content



NAME
Set-Content

SYNOPSIS
Writes or replaces the content in an item with new content.

SYNTAX
Set-Content [-LiteralPath] [-Value] [-Credential ] [-Exclude ] [-Filt
er ] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] []

Set-Content [-Path] [-Value] [-Credential ] [-Exclude ] [-Filter ing>] [-Force] [-Include ] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] []


DESCRIPTION
The Set-Content cmdlet is a string-processing cmdlet that writes or replaces the content in the specified item, suc
h as a file. Whereas the Add-Content cmdlet appends content to a file, Set-Content replaces the existing content. Y
ou can type the content in the command or send content through the pipeline to Set-Content.


PARAMETERS
-Credential
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 "Domain01\User01", 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

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

-Exclude
Omits the specified items. The value of this parameter qualifies the Path parameter. Enter a path element or pa
ttern, such as "*.txt". Wildcards are permitted.

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

-Filter
Specifies a filter in the provider's format or language. The value of this parameter qualifies the Path paramet
er. The syntax of the filter, including the use of wildcards, depends on the provider. Filters are more efficie
nt than other parameters, because the provider applies them when retrieving the objects, rather than having Win
dows PowerShell filter the objects after they are retrieved.

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

-Force []
Allows the cmdlet to set the contents of a file, even if the file is read-only. Implementation varies from prov
ider to provider. For more information, see about_Providers. Even using the Force parameter, the cmdlet cannot
override security restrictions.

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

-Include
Changes only the specified items. The value of this parameter qualifies the Path parameter. Enter a path elemen
t or pattern, such as "*.txt". Wildcards are permitted.

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

-LiteralPath
Specifies the path to the item that will receive the content. Unlike Path, the value of LiteralPath is used exa
ctly as it is typed. No characters are interpreted as wildcards. If the path includes escape characters, enclos
e it in single quotation marks. Single quotation marks tell Windows PowerShell not to interpret any characters
as escape sequences.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-PassThru []
Returns an object representing the content. By default, this cmdlet does not generate any output.

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

-Path
Specifies the path to the item that will receive the content. Wildcards are permitted.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Value
Specifies the new content for the item.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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

-UseTransaction []
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress.
For more information, see about_Transactions.

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
System.Object
You can pipe an object that contains the new value for the item to Set-Content.


OUTPUTS
None or System.String
When you use the Passthru parameter, Set-Content generates a System.String object representing the content. Oth
erwise, this cmdlet does not generate any output.


NOTES


You can also refer to Set-Content by its built-in alias, "sc". For more information, see about_Aliases.

Set-Content is designed for string processing. If you pipe non-string objects to Set-Content, it converts the o
bject to a string before writing it. To write objects to files, use Out-File.

The Set-Content cmdlet is designed to work with the data exposed by any provider. To list the providers availab
le in your session, type "Get-PsProvider". For more information, see about_Providers.


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

C:\PS>set-content -path C:\Test1\test*.txt -value "Hello, World"


Description
-----------
This command replaces the contents of all files in the Test1 directory that have names beginning with "test" with "
Hello, World". This example shows how to specify content by typing it in the command.





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

C:\PS>get-date | set-content C:\Test1\date.csv


Description
-----------
This command creates a comma-separated variable-length (csv) file that contains only the current date and time. It
uses the Get-Date cmdlet to get the current system date and time. The pipeline operator passes the result to Set-Co
ntent, which creates the file and writes the content.

If the Test1 directory does not exist, the command fails, but if the file does not exist, the command will create i
t.





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

C:\PS>(get-content Notice.txt) | foreach-object {$_ -replace "Warning", "Caution"} | set-content Notice.txt


Description
-----------
This command replaces all instances of "Warning" with "Caution" in the Notice.txt file.

It uses the Get-Content cmdlet to get the content of Notice.txt. The pipeline operator sends the results to the For
Each-Object cmdlet, which applies the expression to each line of content in Get-Content. The expression uses the "$
_" symbol to refer to the current item and the Replace parameter to specify the text to be replaced.

Another pipeline operator sends the changed content to Set-Content which replaces the text in Notice.txt with the n
ew content.

The parentheses around the Get-Content command ensure that the Get operation is complete before the Set operation b
egins. Without them, the command will fail because the two functions will be trying to access the same file.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113392
about_Providers
Add-Content
Get-Content
Clear-Content