Method MatrixGetInputLabel

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixGetInputLabel(int, int)

Gets the label of the specified matrix input.

public virtual string MatrixGetInputLabel(int pid, int index)

Parameters

pid int

The ID of the matrix parameter.

index int

The index of the input.

Returns

string

The label of the specified matrix input.

Examples

Element element = engine.FindElement(400, 2000);
string inputLabel = element.MatrixGetInputLabel(1000, 10);

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.

MatrixGetInputLabel(string, int)

Gets the label of the specified matrix input.

public virtual string MatrixGetInputLabel(string parameterName, int index)

Parameters

parameterName string

The name of the matrix parameter.

index int

The index of the input.

Returns

string

The label of the specified matrix input.

Examples

Element element = engine.FindElement(400, 2000);
string inputLabel = element.MatrixGetInputLabel("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.