[switch] $NoInheritance - Powershell Code

Hi All,

I am trying to understand this line of code, what exactly is the [switch] $NoInheritance ? how does it work?

function DoPermissions
{
    param( $permissionGroup, $folder, $level, [switch] $NoInheritance)
}

Open in new window

Thank you in advance

Kelly GarciaSenior Systems AdministratorAsked: 2017-04-10

Who is Participating?

[Product update] Infrastructure Analysis Tool is now available with Business Accounts.Learn More

Experts Exchange Solution brought to you by

Enjoy your complimentary solution view.

Get every solution instantly with Premium. Start your 7-day free trial.

I wear a lot of hats...

"The solutions and answers provided on Experts Exchange have been extremely helpful to me over the last few years. I wear a lot of hats - Developer, Database Administrator, Help Desk, etc., so I know a lot of things but not a lot about one thing. Experts Exchange gives me answers from people who do know a lot about one thing, in a easy to use platform." -Todd S.

LVL 73

Qlemo"Batchelor", Developer and EE Topic AdvisorCommented: 2017-04-10

A switch is an optional parameter without (explicit) value (in fact it is a boolean). If left out when calling the function, it is $false, if you call with -NoInheritance it is $true.
You can call it with an explicit value, which you might want to do if the default value differs from $false, by e.g. using -NoInheritance:$false.

Kelly GarciaSenior Systems AdministratorAuthor Commented: 2017-04-10

ok I kind of get it, if do dopermissions --NoInheritance it will:

switch (noinheritance)
{
Pattern 1 {Statement block}
Pattern 2 {Statement block}
Pattern n {Statement block}
}

is this correct?

LVL 73

Qlemo"Batchelor", Developer and EE Topic AdvisorCommented: 2017-04-10

No. [switch] and switch are totally different kind of things. $NoInheritance just has the values $false or $true, depending on what has been provided or left out at calling the function.

Kelly GarciaSenior Systems AdministratorAuthor Commented: 2017-04-10

ok thank you, any examples to help me understand?

LVL 73

Qlemo"Batchelor", Developer and EE Topic AdvisorCommented: 2017-04-10

function DoPermissions
{
    param( $permissionGroup, $folder, $level, [switch] $NoInheritance)
    if (!$NoInheritance)
    {
      <# code to add inheritance #>
    } else {
      <# code without inheritance #>
    }
}

# This are the same
DoPermissions -NoInheritance
DoPermissions -NoInheritance:$true

# This are the same, but reverse meaning to above
DoPermissions
DoPermissions -NoInheritance:$false

Open in new window

Experts Exchange Solution brought to you by

Your issues matter to us.

Facing a tech roadblock? Get the help and guidance you need from experienced professionals who care. Ask your question anytime, anywhere, with no hassle.

Start your 7-day free trial