BncsFramework.GetInstanceParameter Method (String, String, Boolean)

<< Click to Display Table of Contents >>

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

BncsFramework.GetInstanceParameter Method (String, String, Boolean)

Retrieves an instance parameter based on the specified instance ID and parameter name.

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

 

Syntax


public static Nullable<IBNCSInstanceParameter> GetInstanceParameter(
 string instanceId,
 string parameterName,
 Boolean clone
)

Parameters

instanceId

Type: String
The unique identifier of the instance.

parameterName

Type: String
The name of the parameter to retrieve.

clone

Type: Boolean
Indicates whether to return a cloned instance of the parameter. Default is true.

Return Value

An IBNCSInstanceParameter object representing the instance parameter, or null if the parameter is not found.

 

Exceptions


Exception

Condition

[KeyNotFoundException]

Thrown when the specified parameter is not found in either the managed or monitored instance parameters.

 

See Also


BncsFramework Class

GetInstanceParameter Overload

BNCS.Core.DriverFramework Namespace