Method MatrixGetInputLockMode

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixGetInputLockMode(int, string)

Gets a value indicating whether the specified matrix input is locked.

public virtual bool MatrixGetInputLockMode(int pid, string inputLabel)

Parameters

pid int

The ID of the matrix parameter.

inputLabel string

The label of the matrix input.

Returns

bool

true if the specified matrix input is locked; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
bool isLocked = dummy.MatrixGetInputLockMode(1000, "Input 1");

Exceptions

DataMinerException

The matrix parameter was not found.
-or-
There is no input with the specified label.

MatrixGetInputLockMode(int, int)

Gets a value indicating whether the specified matrix input is locked.

public virtual bool MatrixGetInputLockMode(int pid, int index)

Parameters

pid int

The ID of the matrix parameter.

index int

The index of the matrix input.

Returns

bool

true if the specified matrix input is locked; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
bool isLocked = dummy.MatrixGetInputLockMode(1000, 4);

Remarks

index must be in the range 1..nrOfInputs.

Exceptions

DataMinerException

The matrix parameter was not found.
-or-
index is not in the range 1..nrOfInputs.

MatrixGetInputLockMode(string, int)

Gets a value indicating whether the specified matrix input is locked.

note

Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

[Obsolete("Use overloads with parameter ID instead of name.")]
public virtual bool MatrixGetInputLockMode(string parameterName, int index)

Parameters

parameterName string

The name of the matrix parameter.

index int

The index of the matrix input.

Returns

bool

true if the specified matrix input is locked; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
bool isLocked = dummy.MatrixGetInputLockMode("Example matrix", 10);

Remarks

The specified value for the parameterName argument should be the value of the Description tag of the parameter and not the value of the Name tag.

index must be in the range 1..nrOfInputs.

Exceptions

DataMinerException

The matrix parameter was not found.
-or-
index is not in the range 1..nrOfInputs.

MatrixGetInputLockMode(string, string)

Gets a value indicating whether the specified matrix input is locked.

note

Please use an overload that takes the parameter ID instead to prevent issues in case the parameter Description changes.

[Obsolete("Use overloads with parameter ID instead of name.")]
public virtual bool MatrixGetInputLockMode(string parameterName, string inputLabel)

Parameters

parameterName string

The name of the matrix parameter.

inputLabel string

The label of the matrix input.

Returns

bool

true if the specified matrix input is locked; otherwise, false.

Examples

var dummy = engine.GetDummy("dummy1");
bool isLocked = dummy.MatrixGetInputLockMode("Example matrix", "Input 1");

Remarks

The specified value for the parameterName argument should be the value of the Description tag of the parameter and not the value of the Name tag.

Exceptions

DataMinerException

The matrix parameter was not found.
-or-
There is no input with the specified label.