Method MatrixGetOutputLockMode

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixGetOutputLockMode(int, string)

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

public virtual bool MatrixGetOutputLockMode(int pid, string outputLabel)

Parameters

pid int

The ID of the matrix parameter.

outputLabel string

The label of the matrix output.

Returns

bool

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

Examples

Element element = engine.FindElement(400, 2000);
bool isLocked = element.MatrixGetOutputLockMode(1000, "Output 4");

Exceptions

DataMinerException

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

MatrixGetOutputLockMode(int, int)

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

public virtual bool MatrixGetOutputLockMode(int pid, int index)

Parameters

pid int

The ID of the matrix parameter.

index int

The index of the matrix output.

Returns

bool

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

Examples

Element element = engine.FindElement(400, 2000);
bool isLocked = element.MatrixGetOutputLockMode(1000, 4);

Remarks

The specified output index must be in the range 1..nrOfOutputs.

Exceptions

DataMinerException

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

MatrixGetOutputLockMode(string, string)

Gets a value indicating whether the specified matrix output 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 MatrixGetOutputLockMode(string parameterName, string outputLabel)

Parameters

parameterName string

The name of the matrix parameter.

outputLabel string

The label of the matrix output.

Returns

bool

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

Examples

Element element = engine.FindElement(400, 2000);
bool isLocked = element.MatrixGetOutputLockMode("Example matrix", "Output 4");

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 output with the specified label.

MatrixGetOutputLockMode(string, int)

Gets a value indicating whether the specified matrix output 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 MatrixGetOutputLockMode(string parameterName, int index)

Parameters

parameterName string

The name of the matrix parameter.

index int

The index of the matrix output.

Returns

bool

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

Examples

Element element = engine.FindElement(400, 2000);
bool isLocked = element.MatrixGetOutputLockMode("Example Matrix", 4);

Remarks

The specified output index must be in the range 1..nrOfOutputs.

Exceptions

DataMinerException

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