BncsFramework.AddManagedDeviceAdhocParameterRange Method

<< Click to Display Table of Contents >>

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

BncsFramework.AddManagedDeviceAdhocParameterRange Method

Adds a managed device ad-hoc parameter range to a specified instance.

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

 

Syntax


public static IBNCSInstanceParameter AddManagedDeviceAdhocParameterRange(
 string instanceId,
 string parameterName,
 string parameterDescription,
 uint slot,
 Nullable<Guid> parameterGuid,
 bool readOnly,
 long defaultValue,
 long minimumValue,
 long maximumValue,
 bool autoRegister
)

Parameters

instanceId

Type: String
The unique identifier of the instance to which the parameter will be added.

parameterName

Type: String
The name of the parameter to be added.

parameterDescription

Type: String
A description of the parameter.

slot

Type: UInt32
The slot number for the parameter. Default is 0.

parameterGuid

Type: Nullable<Guid>
The unique identifier for the parameter. If null, a persistent GUID will be generated.

readOnly

Type: Boolean
Indicates whether the parameter is read-only. Default is false.

defaultValue

Type: Int64
The default value of the parameter. Default is 0.

minimumValue

Type: Int64
The minimum value of the parameter. Default is 0.

maximumValue

Type: Int64
The maximum value of the parameter. Default is Int64.

autoRegister

Type: Boolean
Indicates whether the parameter should be automatically registered. Default is true.

Return Value

An instance of IBNCSInstanceParameter representing the added parameter.

 

Exceptions


Exception

Condition

KeyNotFoundException

Instance {instanceId} not found

KeyNotFoundException

Could not locate instance NMOS Device ID

ArgumentException

Parameter {parameterName} is already defined for this instance and cannot be used again

 

See Also


BncsFramework Class

BNCS.Core.DriverFramework Namespace