BncsFramework.AddManagedDeviceAdhocParameterEnum Method

<< Click to Display Table of Contents >>

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

BncsFramework.AddManagedDeviceAdhocParameterEnum Method

Adds a managed device ad-hoc parameter of type Enum to a specified BNCS instance.

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

 

Syntax


public static IBNCSInstanceParameter AddManagedDeviceAdhocParameterEnum(
 string instanceId,
 string parameterName,
 string parameterDescription,
 EnumState[] states,
 uint slot,
 Nullable<Guid> parameterGuid,
 bool readOnly,
 bool autoRegister
)

Parameters

instanceId

Type: String
The unique identifier of the BNCS instance.

parameterName

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

parameterDescription

Type: String
A description of the parameter.

states

Type: EnumState[]
An array of EnumState representing the possible states of the parameter.

slot

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

parameterGuid

Type: Nullable<Guid>
An optional GUID for the parameter. If not provided, a persistent GUID will be generated.

readOnly

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

autoRegister

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

Return Value

An 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