powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Invoke-Item



NAME
Invoke-Item

SYNOPSIS
Performs the default action on the specified item.

SYNTAX
Invoke-Item [-LiteralPath] [-Credential ] [-Exclude ] [-Filter ] [-Inclu
de ] [-Confirm] [-WhatIf] [-UseTransaction] []

Invoke-Item [-Path] [-Credential ] [-Exclude ] [-Filter ] [-Include ing[]>] [-Confirm] [-WhatIf] [-UseTransaction] []


DESCRIPTION
The Invoke-Item cmdlet performs the default action on the specified item. For example, it runs an executable file o
r opens a document file in the application associated with the document file type. The default action depends on th
e type of item and is determined by the Windows PowerShell provider that provides access to the data.


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 Wind
ows PowerShell filter the objects after they are retrieved.

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

-Include
Performs the default action only on the specified items. The value of this parameter qualifies the Path paramet
er. Enter a path element or pattern, such as "*.txt". Wildcards are permitted.

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

-LiteralPath
Specifies a path to the item. The value of LiteralPath is used exactly as it is typed. No characters are interp
reted as wildcards. If the path includes escape characters, enclose it in single quotation marks. Single quotat
ion 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

-Path
Specifies the path to the selected item.

Required? true
Position? 1
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.String
You can pipe a string that contains a path to Invoke-Item.


OUTPUTS
None
The command does not generate any output. However, output might be generated by the item that it invokes.


NOTES


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


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

C:\PS>invoke-item C:\Test\aliasApr04.doc


Description
-----------
This command opens the file aliasApr04.doc in Microsoft Office Word. In this case, opening in Word is the default a
ction for .doc files.





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

C:\PS>invoke-item "C:\Documents and Settings\Lister\My Documents\*.xls"


Description
-----------
This command opens all of the Microsoft Office Excel spreadsheets in the C:\Documents and Settings\Lister\My Docume
nts folder. Each spreadsheet is opened in a new instance of Excel. In this case, opening in Excel is the default ac
tion for .xls files.






RELATED LINKS
Online version: http://go.microsoft.com/fwlink/?LinkID=113345
about_Providers
Clear-Item
Get-Item
Move-Item
Set-Item
New-Item
Remove-Item
Rename-Item
Copy-Item