HowTo: Add a switch to function/filter/script

I know how to pass a parameter, but I am unsure if there is an easier way to
add just a switch to a function.

Example 1:
Function foo {
Param([string]$server,[string]$file)
$server
$file
}
This gives me the option to either position specific or -server/-file
parameters

Function foo2 {
$args[0]
$args[1]
}
This only lets me do position specific, but doest allow to preset parameters
(i.e. -server)

------------------------

What I would like is to be able to add a switch like -debug
foo -server "myserver" -file "hello.txt" -debug

How would I accomplish this (preferably without having to parse $args.)

You can define a parameter as being of type [switch]. For example,

Function foo
{
Param([string]$server,[string]$file,[switch]debug)
$server
$file
if $debug { write-host "The debug switch is present." }
}

Tom G.

--



Brandon Shell wrote:

> I know how to pass a parameter, but I am unsure if there is an easier
> way to add just a switch to a function.
>
> Example 1:
> Function foo {
> Param([string]$server,[string]$file)
> $server
> $file
> }
> This gives me the option to either position specific or -server/-file
> parameters
>
> Function foo2 {
> $args[0]
> $args[1]
> }
> This only lets me do position specific, but doest allow to preset
> parameters (i.e. -server)
>
> ------------------------
>
> What I would like is to be able to add a switch like -debug
> foo -server "myserver" -file "hello.txt" -debug
>
> How would I accomplish this (preferably without having to parse
> $args.)

Thanks... that answers my question... I figured it was easy
"Tom G." <thomglow@lycos.com> wrote in message
news:eqKT6R2KHHA.3872@TK2MSFTNGP06.phx.gbl...
> You can define a parameter as being of type [switch]. For example,
>
> Function foo
> {
> Param([string]$server,[string]$file,[switch]debug)
> $server
> $file
> if $debug { write-host "The debug switch is present." }
> }
>
> Tom G.
>
> --
>
>
>
> Brandon Shell wrote:
>
>> I know how to pass a parameter, but I am unsure if there is an easier
>> way to add just a switch to a function.
>>
>> Example 1:
>> Function foo {
>> Param([string]$server,[string]$file)
>> $server
>> $file
>> }
>> This gives me the option to either position specific or -server/-file
>> parameters
>>
>> Function foo2 {
>> $args[0]
>> $args[1]
>> }
>> This only lets me do position specific, but doest allow to preset
>> parameters (i.e. -server)
>>
>> ------------------------
>>
>> What I would like is to be able to add a switch like -debug
>> foo -server "myserver" -file "hello.txt" -debug
>>
>> How would I accomplish this (preferably without having to parse
>> $args.)

For a various ways to use "switch" in your function,
you can refer to this blog entry
http://msgoodies.blogspot.com/2006/1...arameters.html

"Tom G." <thomglow@lycos.com> wrote in message
news:eqKT6R2KHHA.3872@TK2MSFTNGP06.phx.gbl...
> You can define a parameter as being of type [switch]. For example,
>
> Function foo
> {
> Param([string]$server,[string]$file,[switch]debug)
> $server
> $file
> if $debug { write-host "The debug switch is present." }
> }

And even cooler is that you can pass this switch parameter to another
cmdlet's switch parameter e.g.:

function foo([string]$server, [string]$file, [switch]$whatif) {
some-cmdlet $server, $file -WhatIf:$whatif
}

--
Keith

This should do what you are looking for.

-Bob

Example 1:
Function foo {
Param([string]$server,[string]$file,[switch]$debug)
if ($debug) { "Do something" }
$server
$file
}



Brandon Shell wrote:
> I know how to pass a parameter, but I am unsure if there is an easier way to
> add just a switch to a function.
>
> Example 1:
> Function foo {
> Param([string]$server,[string]$file)
> $server
> $file
> }
> This gives me the option to either position specific or -server/-file
> parameters
>
> Function foo2 {
> $args[0]
> $args[1]
> }
> This only lets me do position specific, but doest allow to preset parameters
> (i.e. -server)
>
> ------------------------
>
> What I would like is to be able to add a switch like -debug
> foo -server "myserver" -file "hello.txt" -debug
>
> How would I accomplish this (preferably without having to parse $args.)