IBncsInfodriver.SetValue Method

<< Click to Display Table of Contents >>

Navigation:  Reference > BNCS.Core.DriverFramework.Interfaces Namespace > IBncsInfodriver Interface > IBncsInfodriver Methods >

IBncsInfodriver.SetValue Method

Sets the value of a specified slot index in the infodriver.

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

 

Syntax


Boolean SetValue(
 uint index,
 string value,
 Boolean preApproved,
 Enums.BNCSChangeSources changeSource
)

Parameters

index

Type: UInt32
The index of the slot to set the value for.

value

Type: String
The new value to set for the specified slot index.

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 BNCSChangeSources.Device.

Return Value

Returns true if the value was successfully set; otherwise, an exception is thrown.

 

Exceptions


Exception

Condition

[ArgumentException]

Thrown when the value exceeds 1024 characters.

[ArgumentOutOfRangeException]

Thrown when the specified slot index is not initialized.

 

See Also


IBncsInfodriver Interface

BNCS.Core.DriverFramework.Interfaces Namespace