How to pass a custom enum to a function in powershell

Question

When defining a function, how can you reference a custom enum?

Here's what I'm trying:

Add-Type -TypeDefinition @"
   namespace JB
   {
       public enum InternetZones
       {
          Computer
          ,LocalIntranet
          ,TrustedSites
          ,Internet
          ,RestrictedSites
       }
   }
"@ -Language CSharpVersion3

function Get-InternetZoneLogonMode
{
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory=$true)]   
        [JB.InterfaceZones]$zone
    )
    [string]$regpath = ("HKCU\Software\Microsoft\Windows\CurrentVersion\Internet Settings\Zones\{0}" -f [int]$zone)
    $regpath
    #...
    #Get-PropertyValue 
}

Get-InternetZoneLogonMode -zone [JB.InternetZones]::TrustedSites

But this gives the error:

Get-ZoneLogonMode : Unable to find type [JB.InterfaceZones]. Make sure that the assembly that contains this type is loaded.
At line:29 char:1
+ Get-ZoneLogonMode -zone [JB.InternetZones]::TrustedSites
+ ~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (JB.InterfaceZones:TypeName) [], RuntimeException
    + FullyQualifiedErrorId : TypeNotFound

NB: I'm aware I could use ValidateSet for similar functionality; however that has the disadvantage of only having a name value; as opposed to allowing me to program using friendly names which are then mapped to ints in the background (I could write code for that; but enum seems more appropriate if possible).

I'm using Powershell v4, but ideally I'd like a PowerShell v2 compatible solution as most users are on that version by default.

Update

I've corrected the typo (thanks PetSerAl; well spotted). [JB.InterfaceZones]$zone now changed to [JB.InternetZones]$zone. Now I'm seeing error:

Get-InternetZoneLogonMode : Cannot process argument transformation on parameter 'zone'. Cannot convert value "[JB.InternetZones]::TrustedSites" to type 
"JB.InternetZones". Error: "Unable to match the identifier name [JB.InternetZones]::TrustedSites to a valid enumerator name.  Specify one of the following 
enumerator names and try again: Computer, LocalIntranet, TrustedSites, Internet, RestrictedSites"
At line:80 char:33
+ Get-InternetZoneLogonMode -zone [JB.InternetZones]::TrustedSites
+                                 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidData: (:) [Get-InternetZoneLogonMode], ParameterBindingArgumentTransformationException
    + FullyQualifiedErrorId : ParameterArgumentTransformationError,Get-InternetZoneLogonMode

Your function declares $zone as [JB.InterfaceZones] not as [JB.InternetZones]. — user4003407
– user4003407, Commented Mar 13, 2015 at 12:17
just call it in this way: Get-InternetZoneLogonMode -zone TrustedSites — CB.
– CB., Commented Mar 13, 2015 at 12:36
Perfect thanks both! (I'd originally tried the easy way; but hadn't since correcting the typo). — JohnLBevan
– JohnLBevan, Commented Mar 13, 2015 at 12:41

Matt · Accepted Answer · 2015-03-13 13:27:50Z

3

The ISE gave this one away to me but your attempted syntax was not completely incorrect. I was able to do this and get it to work.

Get-InternetZoneLogonMode -Zone ([JB.InternetZones]::TrustedSites)

Again, If you look at the highlighting you will see how I came to that conclusion.

syntax highlighting

answered Mar 13, 2015 at 13:27

Matt

47.1k9 gold badges90 silver badges125 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

JohnLBevan · Accepted Answer · 2015-03-13 12:44:08Z

0

Per comments by PetSerAl & CB:

Corrected typo in function definition
- from [JB.InterfaceZones]$zone
- to [JB.InternetZones]$zone
Changed function call
- from Get-InternetZoneLogonMode -zone [JB.InternetZones]::TrustedSites
- to Get-InternetZoneLogonMode -zone TrustedSites

answered Mar 13, 2015 at 12:44

JohnLBevan

24.8k16 gold badges107 silver badges201 bronze badges

Collectives™ on Stack Overflow

How to pass a custom enum to a function in powershell

2 Answers 2

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related