官术网_书友最值得收藏!

Piping data to functions

In addition to passing data to functions via parameters, functions can receive data directly from another object or command via a pipe "|". Receiving values by piping helps improve scripting by limiting the use of temporary variables, as well as more easily passing complex object types or descriptors.

How to do it...

In this recipe, we will create a simple function that receives input from command line as well as pipe. To do this, carry out the following steps:

  1. Create a simple function that accepts a parameter:
    Function Square-Num
    {
        Param([float] $FirstNum)
        Write-Host ($FirstNum * $FirstNum)
    }
  2. Use the ValueFromPipeline parameter to enable the script to accept input from the pipeline:
    Function Square-Num
    {
        Param([float]
        [Parameter(ValueFromPipeline = $true)]
        $FirstNum )
        Write-Host ($FirstNum * $FirstNum)
    } 
  3. Test the function using parameters and by passing data from the pipeline:
    How to do it...

How it works...

The script in the first step itself is simple—it creates a variable named $FirstNum, squares it by multiplying the number against itself, and returns the result. In the second step we updated the parameter line with the following code:

    [Parameter(ValueFromPipeline=$true)]

This parameter option allows the function to assign a value to $FirstNum from the command line, as well as from the pipeline. PowerShell will first look for the value on the command line via name or location, and if it isn't listed, it will look for the value from the pipe.

There's more...

PowerShell will attempt to use all arguments provided to a function, and will report errors if there are unknown arguments. For instance, if we try to provide values from the pipeline and command line at the same time as shown in the following screenshot:

There's more...

As you can see from the example, we attempt to pass both 8 and 7 to the Square-Num function, the first via the pipe and the second via the command line. PowerShell reports an error, and then provides an answer of 49, the result of 7 X 7.

主站蜘蛛池模板: 平顺县| 灵川县| 平定县| 博客| 云安县| 台北县| 宜昌市| 西乌| 灌阳县| 朝阳区| 东海县| 兴宁市| 高阳县| 嵊泗县| 独山县| 新和县| 桐乡市| 夹江县| 保山市| 寻甸| 望奎县| 长岛县| 阳谷县| 鄢陵县| 鲁山县| 盱眙县| 昌乐县| 浦东新区| 桂林市| 奉贤区| 思南县| 衡南县| 方城县| 泗洪县| 通化县| 花莲县| 潮安县| 全椒县| 绍兴县| 绥阳县| 彰武县|