< Back
Invoke-Item
Post
NAME Invoke-Item
SYNOPSIS
Performs the default action on the specified item.
SYNTAX
Invoke-Item [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Include <String[]>] -LiteralPath <String[]>
[-UseTransaction] [-WhatIf] [<CommonParameters>]
Invoke-Item [-Path] <String[]> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Include <String[]>]
[-UseTransaction] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Invoke-Item cmdlet performs the default action on the specified item. For example, it runs an executable file or opens a document file in the
application associated with the document file type. The default action depends on the type of item and is determined by the Windows PowerShell
provider that provides access to the data.
PARAMETERS
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-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 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 None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Exclude <String[]>
Specifies, as a string array, an item or items that this cmdlet excludes from the operation. The value of this parameter qualifies the Path
parameter. Enter a path element or pattern, such as *.txt. Wildcards are permitted.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Include <String[]>
Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path
parameter. Enter a path element or pattern, such as *.txt. Wildcards are permitted.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LiteralPath <String[]>
Specifies a path to the item. 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 Windows
PowerShell not to interpret any characters as escape sequences.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Path <String[]>
Specifies the path to the selected item.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-UseTransaction [<SwitchParameter>]
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
You can pipe a string that contains a path to this cmdlet.
OUTPUTS
None
The command does not generate any output. However, output might be generated by the item that it invokes.
NOTES
* This 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.
*
Example 1: Open a file
PS C:\\>Invoke-Item "C:\\Test\\aliasApr04.doc"
This command opens the file aliasApr04.doc in Microsoft Office Word. In this case, opening in Word is the default action for .doc files.
Example 2: Open all files of a specific type
PS C:\\>Invoke-Item "C:\\Documents and Settings\\Lister\\My Documents\\*.xls"
This command opens all of the Microsoft Office Excel spreadsheets in the C:\\Documents and Settings\\Lister\\My Documents folder. Each spreadsheet is
opened in a new instance of Excel. In this case, opening in Excel is the default action for .xls files.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=822243
Clear-Item
Copy-Item
Get-Item
Move-Item
New-Item
Remove-Item
Rename-Item
Set-Item
SYNOPSIS
Performs the default action on the specified item.
SYNTAX
Invoke-Item [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Include <String[]>] -LiteralPath <String[]>
[-UseTransaction] [-WhatIf] [<CommonParameters>]
Invoke-Item [-Path] <String[]> [-Confirm] [-Credential <PSCredential>] [-Exclude <String[]>] [-Filter <String>] [-Include <String[]>]
[-UseTransaction] [-WhatIf] [<CommonParameters>]
DESCRIPTION
The Invoke-Item cmdlet performs the default action on the specified item. For example, it runs an executable file or opens a document file in the
application associated with the document file type. The default action depends on the type of item and is determined by the Windows PowerShell
provider that provides access to the data.
PARAMETERS
-Confirm [<SwitchParameter>]
Prompts you for confirmation before running the cmdlet.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-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 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 None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Exclude <String[]>
Specifies, as a string array, an item or items that this cmdlet excludes from the operation. The value of this parameter qualifies the Path
parameter. Enter a path element or pattern, such as *.txt. Wildcards are permitted.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Include <String[]>
Specifies, as a string array, an item or items that this cmdlet includes in the operation. The value of this parameter qualifies the Path
parameter. Enter a path element or pattern, such as *.txt. Wildcards are permitted.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-LiteralPath <String[]>
Specifies a path to the item. 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 Windows
PowerShell not to interpret any characters as escape sequences.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Path <String[]>
Specifies the path to the selected item.
Required? true
Position? 0
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-UseTransaction [<SwitchParameter>]
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Includes the command in the active transaction. This parameter is valid only when a transaction is in progress. For more information, see
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String
You can pipe a string that contains a path to this cmdlet.
OUTPUTS
None
The command does not generate any output. However, output might be generated by the item that it invokes.
NOTES
* This 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.
*
Example 1: Open a file
PS C:\\>Invoke-Item "C:\\Test\\aliasApr04.doc"
This command opens the file aliasApr04.doc in Microsoft Office Word. In this case, opening in Word is the default action for .doc files.
Example 2: Open all files of a specific type
PS C:\\>Invoke-Item "C:\\Documents and Settings\\Lister\\My Documents\\*.xls"
This command opens all of the Microsoft Office Excel spreadsheets in the C:\\Documents and Settings\\Lister\\My Documents folder. Each spreadsheet is
opened in a new instance of Excel. In this case, opening in Excel is the default action for .xls files.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=822243
Clear-Item
Copy-Item
Get-Item
Move-Item
New-Item
Remove-Item
Rename-Item
Set-Item