Share via

IDynamicParameters.GetDynamicParameters Method

  • Reference

Definition

Namespace:
System.Management.Automation
Assembly:
System.Management.Automation.dll
Package:
Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0
Package:
System.Management.Automation v7.0.13
Package:
System.Management.Automation v7.1.7
Package:
System.Management.Automation v7.2.12
Package:
System.Management.Automation v7.3.5
Package:
System.Management.Automation v7.4.0
Package:
Microsoft.WSMan.Runtime v6.1.0
Package:
Microsoft.WSMan.Runtime v6.2.0

Returns an instance of an object that defines the dynamic parameters for this Cmdlet or CmdletProvider.

public:
 System::Object ^ GetDynamicParameters();
public:
 Platform::Object ^ GetDynamicParameters();
winrt::Windows::Foundation::IInspectable GetDynamicParameters();
public object GetDynamicParameters ();
public object? GetDynamicParameters ();
abstract member GetDynamicParameters : unit -> obj
Public Function GetDynamicParameters () As Object

Returns

Object

This method should return an object that has properties and fields decorated with parameter attributes similar to a Cmdlet or CmdletProvider. These attributes include ParameterAttribute, AliasAttribute, argument transformation and validation attributes, etc.

Alternately, it can return a RuntimeDefinedParameterDictionary instead.

The Cmdlet or CmdletProvider should hold on to a reference to the object which it returns from this method, since the argument values for the dynamic parameters specified by that object will be set in that object.

This method will be called after all formal (command-line) parameters are set, but before BeginProcessing() is called and before any incoming pipeline objects are read. Therefore, parameters which allow input from the pipeline may not be set at the time this method is called, even if the parameters are mandatory.

Applies to