PowerShell Logo Small

Get-ItemProperty



This is the built-in help made by Microsoft for the command 'Get-ItemProperty', in PowerShell version 2 - as retrieved from Windows version 'Microsoft® Windows Vista™ Ultimate ' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Gets the properties of a specified item.

SYNTAX


Get-ItemProperty [-LiteralPath] <string[]> [[-Name] <string[]>] [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Include <
string[]>] [-UseTransaction] [<CommonParameters>]
Get-ItemProperty [-Path] <string[]> [[-Name] <string[]>] [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Include <string[
]>] [-UseTransaction] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The Get-ItemProperty cmdlet gets the properties of the specified items. For example, you can use Get-ItemProperty to get the value of the LastAcc
essTime property of a file object. You can also use Get-ItemProperty to view registry entries and their values.



<

RELATED LINKS

Online version: http://go.microsoft.com/fwlink/?LinkID=113320
about_Providers
Set-ItemProperty
Clear-ItemProperty
Copy-ItemProperty
Move-ItemProperty
New-ItemProperty
Remove-ItemProperty
Rename-ItemProperty

REMARKS

<

Examples


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

C:\PS>get-itemproperty C:\Windows



Description
-----------
This command gets information about the C:\Windows directory.








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

C:\PS>get-itemproperty C:\Test\Weather.xls | format-list



Description
-----------
This command gets the properties of the C:\Test\Weather.xls file. The result is piped to the Format-List cmdlet to display the output as a list.








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

C:\PS>get-itemproperty -path HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion



Description
-----------
This command displays the value name and data of each of the registry entries contained in the CurrentVersion registry subkey. Note that the comm
and requires that there is a Windows PowerShell drive named HKLM: that is mapped to the HKEY_LOCAL_MACHINE hive of the registry. A drive with tha
t name and mapping is available in Windows PowerShell by default. Alternatively, the path to this registry subkey can be specified by using the f
ollowing alternative path that begins with the provider name followed by two colons:
Registry::HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion.








-------------------------- EXAMPLE 4 --------------------------

C:\PS>get-itemproperty -path HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion `
-name "ProgramFilesDir"



Description
-----------
This command gets the value name and data of the ProgramFilesDir registry entry in the CurrentVersion registry subkey. The command uses the Path
parameter to specify the subkey and the Name parameter to specify the value name of the entry.








-------------------------- EXAMPLE 5 --------------------------

C:\PS>get-itemproperty -path HKLM:\SOFTWARE\Microsoft\PowerShell\1\PowerShellEngine

ApplicationBase : C:\Windows\system32\WindowsPowerShell\v1.0\
ConsoleHostAssemblyName : Microsoft.PowerShell.ConsoleHost, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad
364e35, ProcessorArchitecture=msil
PowerShellVersion : 2.0
RuntimeVersion : v2.0.50727
CTPVersion : 5
PSCompatibleVersion : 1.0,2.0



Description
-----------
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.








-------------------------- EXAMPLE 6 --------------------------

C:\PS>get-itemproperty -path HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds\Microsoft.PowerShell

Path ExecutionPolicy
---- ---------------
C:\Windows\system32\WindowsPowerShell\v1.0\powershell.exe RemoteSigned


C:\PS>get-itemproperty -path HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds\Microsoft.PowerShell | format-list -property *

PSPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\Software\Microsoft\PowerShell\1\ShellIds\Micro
soft.PowerShell
PSParentPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\Software\Microsoft\PowerShell\1\ShellIds
PSChildName : Microsoft.PowerShell
PSDrive : HKLM
PSProvider : Microsoft.PowerShell.Core\Registry
Path : C:\Windows\system32\WindowsPowerShell\v1.0\powershell.exe
ExecutionPolicy : RemoteSigned



Description
-----------
This example shows how to format the output of a Get-ItemProperty command in a list to make it easy to see the registry values and data and to ma
ke it easy to interpret the results.

The first command uses the Get-ItemProperty cmdlet to get the registry entries in the Microsoft.PowerShell subkey. This subkey stores options for
the default shell for Windows PowerShell. The results are shown in the following sample output.

The output shows that there are two registry entries, Path and ExecutionPolicy. When a registry key contains fewer than five entries, by default
it is displayed in a table, but it is often easier to view in a list.

The second command uses the same Get-ItemProperty command. However, this time, the command uses a pipeline operator (|) to send the results of th
e command to the Format-List cmdlet. The Format-List command uses the Property parameter with a value of * (all) to display all of the properties
of the objects in a list. The results are shown in the following sample output.

The resulting display shows the Path and ExecutionPolicy registry entries, along with several less familiar properties of the registry key object
. The other properties, prefixed with "PS", are properties of Windows PowerShell custom objects, such as the objects that represent the registry
keys.