<< Click to Display Table of Contents >> Navigation:  Reference > BNCS.Core.DriverFramework Namespace > BncsFramework Class > BncsFramework Methods > BncsFramework.AddManagedDeviceAdhocParameterString Method

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

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

 

Syntax

---

public static IBNCSInstanceParameter AddManagedDeviceAdhocParameterString(
 string instanceId,
 string parameterName,
 string parameterDescription,
 uint slot,
 Nullable<Guid> parameterGuid,
 BNCSEnums.StringCases parameterCase,
 uint maxLength,
 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.

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.

parameterCase

Type: BNCS.BNCSEnums.StringCases
The case sensitivity setting for the parameter string. Default is Any.

maxLength

Type: UInt32
The maximum length of the parameter string. Default is 4096.

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 instance of IBNCSInstanceParameter representing the added parameter.

 

Exceptions

---

 

See Also

---

BncsFramework Class

BNCS.Core.DriverFramework Namespace