- Reference
- Module:
- Microsoft.PowerShell.Management
Gets the properties of a specified item.
Syntax
Get-ItemProperty [-Path] <String[]> [[-Name] <String[]>] [-Filter <String>] [-Include <String[]>] [-Exclude <String[]>] [-Credential <PSCredential>] [<CommonParameters>]
Get-ItemProperty -LiteralPath <String[]> [[-Name] <String[]>] [-Filter <String>] [-Include <String[]>] [-Exclude <String[]>] [-Credential <PSCredential>] [<CommonParameters>]
Description
The Get-ItemProperty
cmdlet gets the properties of the specified items. For example, you can usethis cmdlet to get the value of the LastAccessTime property of a file object. You can also usethis cmdlet to view registry entries and their values.
Examples
Example 1: Get information about a specific directory
This command gets information about the C:\Windows
directory.
Get-ItemProperty C:\Windows
Example 2: Get the properties of a specific file
This command gets the properties of the C:\Test\Weather.xls
file. The result is piped to theFormat-List
cmdlet to display the output as a list.
Get-ItemProperty C:\Test\Weather.xls | Format-List
Example 3: Get the value name and data of a registry entry in a registry subkey
This command gets the value name and data of the ProgramFilesDir
registry entry in theCurrentVersion
registry subkey. The Path specifies the subkey and the Name parameterspecifies the value name of the entry.
Get-ItemProperty -Path HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion -Name "ProgramFilesDir"
Note
This command requires that there is a PowerShell drive named HKLM:
that is mapped to theHKEY_LOCAL_MACHINE
hive of the registry.
A drive with that name and mapping is available in PowerShell by default. Alternatively, the pathto this registry subkey can be specified by using the following alternative path that begins withthe provider name followed by two colons:
Registry::HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion
.
Example 4: Get the value names and data of registry entries in a registry key
This command gets the value names and data of the registry entries in the PowerShellEngine
registry key. The results are shown in the following sample output.
Get-ItemProperty -Path HKLM:\SOFTWARE\Microsoft\PowerShell\1\PowerShellEngineApplicationBase : C:\Windows\system32\WindowsPowerShell\v1.0\ConsoleHostAssemblyName : Microsoft.PowerShell.ConsoleHost, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, ProcessorArchitecture=msilPowerShellVersion : 2.0RuntimeVersion : v2.0.50727CTPVersion : 5PSCompatibleVersion : 1.0,2.0
Parameters
-Credential
Note
This parameter is not supported by any providers installed with PowerShell. To impersonate anotheruser, or elevate your credentials when running this cmdlet, useInvoke-Command.
Type: | PSCredential |
Position: | Named |
Default value: | Current user |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Exclude
Specifies, as a string array, an item or items that this cmdlet excludes in the operation. The valueof this parameter qualifies the Path parameter. Enter a path element or pattern, such as*.txt
. Wildcard characters are permitted. The Exclude parameter is effective only when thecommand includes the contents of an item, such as C:\Windows\*
, where the wildcard characterspecifies the contents of the C:\Windows
directory.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Filter
Specifies a filter to qualify the Path parameter. TheFileSystem provider is the onlyinstalled PowerShell provider that supports the use of filters. You can find the syntax for theFileSystem filter language inabout_Wildcards. Filters are more efficientthan other parameters, because the provider applies them when the cmdlet gets the objects ratherthan having PowerShell filter the objects after they are retrieved.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Include
Specifies, as a string array, an item or items that this cmdlet includes in the operation. The valueof this parameter qualifies the Path parameter. Enter a path element or pattern, such as*.txt
. Wildcard characters are permitted. The Include parameter is effective only when thecommand includes the contents of an item, such as C:\Windows\*
, where the wildcard characterspecifies the contents of the C:\Windows
directory.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-LiteralPath
Specifies a path to one or more locations. The value of LiteralPath is used exactly as it istyped. No characters are interpreted as wildcards. If the path includes escape characters, encloseit in single quotation marks. Single quotation marks tell PowerShell not to interpret any charactersas escape sequences.
For more information, seeabout_Quoting_Rules.
Type: | String[] |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Specifies the name of the property or properties to retrieve. Wildcard characters are permitted.
Type: | String[] |
Aliases: | PSProperty |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
-Path
Specifies the path to the item or items. Wildcard characters are permitted.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
Inputs
String
You can pipe a string that contains a path to this cmdlet.
Outputs
Boolean
String
DateTime
FileInfo
DirectoryInfo
This cmdlet returns an object for each item property that it gets. The object type depends onthe object that is retrieved. For example, in a file system drive, it might return a file or folder.
Notes
PowerShell includes the following aliases for Get-ItemProperty
:
- All platforms:
gp
The Get-ItemProperty
cmdlet is designed to work with the data exposed by any provider. To list theproviders available in your session, type Get-PSProvider
. For more information, seeabout_Providers.
- Clear-ItemProperty
- Copy-ItemProperty
- Move-ItemProperty
- New-ItemProperty
- Remove-ItemProperty
- Rename-ItemProperty
- Set-ItemProperty
- about_Providers