PSObjectPropertyDescriptor.SetValue(Object, Object) 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

Sets the value of the component to a different value.

public:
 override void SetValue(System::Object ^ component, System::Object ^ value);
public:
 override void SetValue(Platform::Object ^ component, Platform::Object ^ value);
 override void SetValue(winrt::Windows::Foundation::IInspectable const & component, winrt::Windows::Foundation::IInspectable const & value);
public override void SetValue (object component, object value);
override this.SetValue : obj * obj -> unit
Public Overrides Sub SetValue (component As Object, value As Object)

Parameters

component
Object

The component with the property value that is to be set.

value
Object

The new value.

Exceptions

ExtendedTypeSystemException

If the property has not been found in the component or an exception has been thrown when setting the value of the property. This Exception will only be thrown if there is no event handler for the SettingValueException event of the PSObjectTypeDescriptor that created this PSObjectPropertyDescriptor. If there is an event handler, it can prevent this exception from being thrown, by changing the ShouldThrow property of SettingValueExceptionEventArgs from its default value of true to false.

PSArgumentNullException

If component is null.

PSArgumentException

If component is not an PSObject or an PSObjectTypeDescriptor.

Applies to