Clarify that not providing a -ParameterName argument implies the -Native switch

[mklement0]

Type of issue

Missing information

Feedback

Register-ArgumentCompleter's parameter design is unusual in that a switch (-Native) is situationally implied (whereas switch parameters normally require opt-in).

It's worth mentioning that when a -ParameterName argument is (possibly accidentally) not supplied, -Native is implied, which fundamentally changes the arguments passed to the -ScriptBlock argument and can therefore cause confusion; see:

• Parameters of ScriptBlock in Register-ArgumentComplete are set incorrectly PowerShell/PowerShell#24031

Page URL

https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/register-argumentcompleter?view=powershell-7.4

Content source URL

https://github.com/MicrosoftDocs/PowerShell-Docs/blob/main/reference/7.4/Microsoft.PowerShell.Core/Register-ArgumentCompleter.md

Author

@sdwheeler

Document Id

e471c27f-aa83-321f-541f-878442638e1b

[ar-std]

I would additionally consider to remove the switch -Native entirely as

Register-ArgumentCompleter
        -CommandName <String[]>
        -ScriptBlock <ScriptBlock>
        [<CommonParameters>]

... , nonetheless, already leads to the script block parameters as described for -Native. And if providing $ParameterName in

Register-ArgumentCompleter
        [-CommandName <String[]>]
        -ParameterName <String>
        -ScriptBlock <ScriptBlock>
        [<CommonParameters>]

..., -Native is not allowed.