I got some nice feedback on my original Test-RegistryItem function. I had been mulling some enhancements anyway and now have a more robust version that looks at individual values, accepts pipelined input and more The new version now lets you test if a given registry item exists as well as if the value meets some target value. First, here's the new version, with comment help removed.<\/p>\n
Function Test-RegistryItem {\r\n\r\n[cmdletbinding()]\r\n\t\r\nParam (\r\n\t[Parameter(Position=0,Mandatory=$True,\r\n ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True,\r\n HelpMessage=\"Enter a registry path using the PSDrive format.\")]\r\n\t[ValidateNotNullOrEmpty()]\r\n [Alias(\"PSPath\")]\r\n [string]$Path,\r\n \r\n\t[Parameter(Position=1,Mandatory=$True,\r\n ValueFromPipeline=$True,ValueFromPipelineByPropertyName=$True,\r\n HelpMessage=\"Enter a registry key name.\")]\r\n\t[ValidateNotNullOrEmpty()]\r\n\t[Alias(\"name\",\"item\")]\r\n [string]$Property,\r\n\r\n [Parameter()]\r\n [Alias(\"value\")]\r\n\t[string]$TargetValue,\r\n \r\n [Switch]$UseTransaction\r\n)\r\n\r\nProcess {\r\n \tWrite-Verbose (\"Looking for {0} in {1}\" -f $Property,$Path)\r\n if (Test-Path $path) \r\n {\r\n \tif ($UseTransaction) \r\n \t{\r\n \t\t$item=Get-ItemProperty -Path $path -Name $property -ErrorAction \"SilentlyContinue\" -UseTransaction\r\n \t} else\r\n \t{\r\n \t\t$item=Get-ItemProperty -Path $path -Name $property -ErrorAction \"SilentlyContinue\" \r\n \t}\r\n \t\r\n if ($item ) \r\n {\r\n #display the item if using -Verbose\r\n \tWrite-Verbose ($item | select * | Out-String)\r\n $Exists=$True\r\n if ($TargetValue)\r\n {\r\n $ActualValue=$item.$Property\r\n Write-Verbose \"Retrieving value for $Property\"\r\n if ($ActualValue -eq $TargetValue) \r\n {\r\n $PropertyMatch=$True\r\n }\r\n else\r\n {\r\n $PropertyMatch=$False\r\n }\r\n } #if $value\r\n } #if $item\r\n else \r\n {\r\n \tWrite-Verbose \"Not found\"\r\n $Exists=$False\r\n $PropertyMatch=$False\r\n }\r\n } #if test-path\r\n else \r\n {\r\n Write-Warning \"Failed to find $path\"\r\n $Exists=$False\r\n }\r\n \r\n #create a custom object\r\n $obj=New-Object -TypeName PSObject -Property @{\r\n \"Path\"=$path\r\n \"Property\"=$Property\r\n \"Exists\"=$Exists\r\n }\r\n #add additional properties if looking for a property match\r\n if ($TargetValue) \r\n {\r\n Write-Verbose \"Adding TargetValue Properties\"\r\n $obj | Add-Member -MemberType NoteProperty -Name \"PropertyMatch\" -Value $PropertyMatch\r\n $obj | Add-Member -MemberType NoteProperty -Name \"TargetValue\" -Value $TargetValue\r\n $obj | Add-Member -MemberType NoteProperty -Name \"ActualValue\" -Value $ActualValue\r\n }\r\n #write the result to the pipeline\r\n write $obj\r\n \r\n } #end Process\r\n\r\n} #end function\r\n<\/pre>\nThe new version writes a custom object to the pipeline which provides more information. Let me walk through an example of the new version.<\/p>\n
PS C:\\> Test-RegistryItem -path \"HKLM:\\Software\\Microsoft\\Windows NT\\CurrentVersion\\WinLogon\" -Property \"AutoAdminLogon\" -TargetValue 1<\/pre>\nI want to see if the AutoAdminLogon item has a value of 1. The original part of the function that verifies the path is unchanged. But now if you specify a target value, the function checks to see if the current value matches the actual value.<\/p>\n
if ($TargetValue)\r\n {\r\n $ActualValue=$item.$Property\r\n Write-Verbose \"Retrieving value for $Property\"\r\n if ($ActualValue -eq $TargetValue) \r\n {\r\n $PropertyMatch=$True\r\n }\r\n else\r\n {\r\n $PropertyMatch=$False\r\n }\r\n<\/pre>\nA variable is defined to indicate if the values match. I also define $Exists since the item was found. After checking for the property value, the function creates a custom object with a few baseline properties.<\/p>\n
\r\n #create a custom object\r\n $obj=New-Object -TypeName PSObject -Property @{\r\n \"Path\"=$path\r\n \"Property\"=$Property\r\n \"Exists\"=$Exists\r\n }<\/pre>\nIf I hadn't been checking a specific property value, this object would have been written to the pipeline. But because I wanted to confirm a target value, a few additional properties are added to the object.<\/p>\n
if ($TargetValue) \r\n {\r\n Write-Verbose \"Adding TargetValue Properties\"\r\n $obj | Add-Member -MemberType NoteProperty -Name \"PropertyMatch\" -Value $PropertyMatch\r\n $obj | Add-Member -MemberType NoteProperty -Name \"TargetValue\" -Value $TargetValue\r\n $obj | Add-Member -MemberType NoteProperty -Name \"ActualValue\" -Value $ActualValue\r\n }\r\n<\/pre>\nI end up with a custom object like this.<\/p>\n
\r\nProperty : AutoAdminLogon\r\nPath : HKLM:\\Software\\Microsoft\\Windows NT\\CurrentVersion\\WinLogon\r\nExists : True\r\nPropertyMatch : False\r\nTargetValue : 1\r\nActualValue : 0<\/pre>\nThe function also takes pipelined input so I can quickly check to see what keys might be missing. And because I'm now writing an object to the pipeline I can easily filter my results.<\/p>\n
\r\nPS C:\\> import-csv winlogon.csv | test-registryitem | Where {-Not $_.Exists} \r\n\r\nProperty Path Exists\r\n-------- ---- ------\r\nFOODisableCAD HKLM:\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Winlogon False\r\nFOOShutdownFlags HKLM:\\Software\\Microsoft\\Windows NT\\CurrentVersion\\Winlogon False\r\n<\/pre>\nI hope you'll download the new version and let me know what you think. Oh..and that CSV file referenced in the last example? I've got that goody saved for another day.<\/p>\n