函数在PowerShell中的返回值

我开发了一个PowerShell函数，它执行了许多涉及提供SharePoint团队站点的操作。最终，我想函数返回的URL提供的网站作为字符串，所以在我的函数结束，我有以下代码:

$rs = $url.ToString();
return $rs;

调用这个函数的代码如下所示:

$returnURL = MyFunction -param 1 ...

我期待的是一个字符串，但它不是。相反，它是System.Management.Automation.PSMethod类型的对象。为什么它返回的是那个类型而不是String类型?

当前回答

现有的答案是正确的，但有时实际上并没有显式地返回Write-Output或return，但函数结果中有一些神秘的值。这可以是像New-Item这样的内置函数的输出

PS C:\temp> function ContrivedFolderMakerFunction {
>>    $folderName = [DateTime]::Now.ToFileTime()
>>    $folderPath = Join-Path -Path . -ChildPath $folderName
>>    New-Item -Path $folderPath -ItemType Directory
>>    return $true
>> }
PS C:\temp> $result = ContrivedFolderMakerFunction
PS C:\temp> $result


    Directory: C:\temp


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----         2/9/2020   4:32 PM                132257575335253136
True

所有创建目录的额外噪音都被收集并在输出中发出。缓解这种情况的简单方法是在New-Item语句的末尾添加| Out-Null，或者您可以将结果分配给一个变量，但不使用该变量。它看起来是这样的……

PS C:\temp> function ContrivedFolderMakerFunction {
>>    $folderName = [DateTime]::Now.ToFileTime()
>>    $folderPath = Join-Path -Path . -ChildPath $folderName
>>    New-Item -Path $folderPath -ItemType Directory | Out-Null
>>    # -or-
>>    $throwaway = New-Item -Path $folderPath -ItemType Directory 
>>    return $true
>> }
PS C:\temp> $result = ContrivedFolderMakerFunction
PS C:\temp> $result
True

New-Item可能是其中更著名的，但其他方法包括所有StringBuilder.Append*()方法，以及SqlDataAdapter.Fill()方法。

2020-02-09 21:41:37

其他回答

PowerShell有非常古怪的返回语义——至少从更传统的编程角度来看是这样。这里有两个值得你思考的观点:

捕获并返回所有输出 return关键字实际上只是指示了一个逻辑退出点

因此，下面两个脚本块将有效地完成完全相同的事情:

$a = "Hello, World"
return $a

$a = "Hello, World"
$a
return

第二个示例中的$a变量被保留为管道上的输出，并且如前所述，将返回所有输出。事实上，在第二个示例中，您可以完全省略返回，并且您将得到相同的行为(返回将在函数自然完成和退出时隐含)。

没有更多的函数定义，我不能说为什么你得到一个PSMethod对象。我的猜测是，您可能有一些未被捕获的内容，它们被放置在输出管道中。

同样值得注意的是，您可能不需要这些分号——除非您在一行上嵌套多个表达式。

您可以在TechNet的about_Return页面上阅读更多关于返回语义的信息，或者通过从PowerShell本身调用帮助返回命令。

2012-04-23 21:01:56

我传递了一个简单的Hashtable对象和一个结果成员，以避免返回的疯狂，因为我也想输出到控制台。它通过引用传递起作用。

function sample-loop($returnObj) {
  for($i = 0; $i -lt 10; $i++) {
    Write-Host "loop counter: $i"
    $returnObj.result++
  }
}

function main-sample() {
  $countObj = @{ result = 0 }
  sample-loop -returnObj $countObj
  Write-Host "_____________"
  Write-Host "Total = " ($countObj.result)
}

main-sample

你可以在我的GitHub项目unpackTunes中看到真实的使用示例。

2015-08-23 23:27:31

现有的答案是正确的，但有时实际上并没有显式地返回Write-Output或return，但函数结果中有一些神秘的值。这可以是像New-Item这样的内置函数的输出

PS C:\temp> function ContrivedFolderMakerFunction {
>>    $folderName = [DateTime]::Now.ToFileTime()
>>    $folderPath = Join-Path -Path . -ChildPath $folderName
>>    New-Item -Path $folderPath -ItemType Directory
>>    return $true
>> }
PS C:\temp> $result = ContrivedFolderMakerFunction
PS C:\temp> $result


    Directory: C:\temp


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----         2/9/2020   4:32 PM                132257575335253136
True

PS C:\temp> function ContrivedFolderMakerFunction {
>>    $folderName = [DateTime]::Now.ToFileTime()
>>    $folderPath = Join-Path -Path . -ChildPath $folderName
>>    New-Item -Path $folderPath -ItemType Directory | Out-Null
>>    # -or-
>>    $throwaway = New-Item -Path $folderPath -ItemType Directory 
>>    return $true
>> }
PS C:\temp> $result = ContrivedFolderMakerFunction
PS C:\temp> $result
True

New-Item可能是其中更著名的，但其他方法包括所有StringBuilder.Append*()方法，以及SqlDataAdapter.Fill()方法。

2020-02-09 21:41:37

如果不查看代码，就很难说。确保函数不返回一个以上的对象，并且捕获其他调用产生的任何结果。你得到了什么: