BncsFramework.SetParameterValue Method

<< Click to Display Table of Contents >>

Navigation:  Reference > BNCS.Core.DriverFramework Namespace > BncsFramework Class > BncsFramework Methods >

BncsFramework.SetParameterValue Method

Sets the value of a specified instance parameter and publishes a change notification.

Namespace: BNCS.Core.DriverFramework
Assembly:  BNCS.Core.DriverFramework (in BNCS.Core.DriverFramework.dll)

 

Syntax


public static bool SetParameterValue(
 IBNCSInstanceParameter param,
 Boolean preApproved,
 Enums.BNCSChangeSources changeSource
)

Parameters

param

Type: BNCS.Interfaces.IBNCSInstanceParameter
The instance parameter whose value is to be set.

preApproved

Type: Boolean
Indicates whether the change is pre-approved. Default is true.

changeSource

Type: BNCS.Core.DriverFramework.Models.Enums.BNCSChangeSources
The source of the change. Default is Device.

Return Value

Returns true if the parameter value is successfully set and the change notification is published.

 

Exceptions


Exception

Condition

[KeyNotFoundException]

Thrown when the specified parameter cannot be found.

 

See Also


BncsFramework Class

BNCS.Core.DriverFramework Namespace