Passing script parameters to a function in Powershell

Question

My Script calls a function that needs the parameters from the calling of the scripts:

function new( $args )
{
  if( $args.length -lt 8 )
  {
    Write-Host "Parameter Missing, requires 8 Parameters. Aborting."!
    Write-Host $args.length
    break
  }
}

switch ($args[0]) {
  '--test' { }
  '--new' { new $args }
  default  { }
}

When I call it, the args array is not handed over to the new function:

PS Q:\mles\etl-i_test> .\iprog.ps1 --new 1 2 3 4 5 6 7
Parameter Missing, requires 8 Parameters. Aborting. !
0

How do I pass an array to a function in powershell? Or specifically, the $args array? Shouldn't the scope for the $args array be global?

Try using param(...) - stackoverflow.com/a/12425338/763026 — Angshuman Agarwal
– Angshuman Agarwal, Commented Apr 5, 2013 at 14:46

RinoTom · Accepted Answer · 2013-04-05 15:11:32Z

3

Modify your function as below:

function new { param([string[]] $paramargs)

  if( $paramargs.length -lt 8 )
  {
    Write-Host "Parameter Missing, requires 8 Parameters. Aborting."!
    Write-Host $paramargs.length
    break
  }
}

switch ($args[0]) {
  '--test' { }
  '--new' { new $args }
  default  { }
}

This will avoid the ambiguity of the variable $arg from command line and parameter $arg (changed as $paramarg).

answered Apr 5, 2013 at 15:11

RinoTom

2,3362 gold badges26 silver badges41 bronze badges

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

2 Comments

mles Over a year ago

Renaming $args to something different did the trick, thanks! is param([string[]] necessary? It works without.

RinoTom Over a year ago

Ya, param([string[]] is not required. I tried that way and posted so :)

E.V.I.L. · Accepted Answer · 2013-04-05 15:45:20Z

2

The $args is always part of any function. When you call a function with $args as the name of an argument things get pretty confusing. In your function change the name to something other than $args and it should work.

function new( $arguments )
{

$arguments.Length
  if( $arguments.length -lt 8 )
  {
    Write-Host "Parameter Missing, requires 8 Parameters. Aborting."!
    Write-Host $arguments.length
    break
  }
}

switch ($args[0]) {
  '--test' { }
  '--new' { new $args }
  default  { }
}

answered Apr 5, 2013 at 15:45

E.V.I.L.

2,16613 silver badges14 bronze badges

Comments

mjolinor · Accepted Answer · 2013-04-05 15:00:13Z

1

You must pass $args from a parent scope to a child scope explicitly. $args in the parent scope is never visible in a chlid scope, because the scope is initialized with it's own $args. Do this:

&{get-variable -scope 0}

and note the results. Every variable you see there is created locally in the new scope when the scope is initialized, so those variables in the parent scope aren't visible in the new scope. $args is one of those variables.

answered Apr 5, 2013 at 15:00

mjolinor

68.7k7 gold badges118 silver badges141 bronze badges

1 Comment

mles Over a year ago

Ah interesting. I can not overwrite $args in a function.

Collectives™ on Stack Overflow

Passing script parameters to a function in Powershell

3 Answers 3

2 Comments

Comments

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related