New-TemporaryFile
Creates a temporary file.
Syntax
New-TemporaryFile
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
This cmdlet creates temporary files that you can use in scripts.
The New-TemporaryFile
cmdlet creates an empty file that has the .tmp
file name extension.
This cmdlet names the file tmp<NNNN>.tmp
, where <NNNN>
is a random hexadecimal number.
The cmdlet creates the file in your TEMP folder.
This cmdlet uses the Path.GetTempPath() method to find your TEMP folder. This method checks for the existence of environment variables in the following order and uses the first path found:
On Windows platforms:
- The path specified by the TMP environment variable.
- The path specified by the TEMP environment variable.
- The path specified by the USERPROFILE environment variable.
- The Windows directory.
On non-Windows platforms: Uses the path specified by the TMPDIR environment variable.
Examples
Example 1: Create a temporary file
$TempFile = New-TemporaryFile
This command generates a .tmp
file in your temporary folder, and then stores a reference to the file
in the $TempFile
variable. You can use this file later in your script.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
This cmdlet returns a FileInfo object that represents the temporary file.
PowerShell