Method MatrixGetInputIndexFromInputLabel

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixGetInputIndexFromInputLabel(int, string)

Gets the index of the input that corresponds with the specified input label.

public virtual int MatrixGetInputIndexFromInputLabel(int pid, string inputLabel)

Parameters

pid int

The ID of the matrix parameter.

inputLabel string

The label of the input.

Returns

int

The corresponding input index.

Examples

var dummy = engine.GetDummy("dummy1");
int index = dummy.MatrixGetInputIndexFromInputLabel(1000, "Input 10");

Remarks

The returned index is in the range 1..nrOfInputs.

Exceptions

DataMinerException

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

MatrixGetInputIndexFromInputLabel(string, string)

Gets the index of the input that corresponds with the specified input label.

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 int MatrixGetInputIndexFromInputLabel(string parameterName, string inputLabel)

Parameters

parameterName string

The name of the matrix parameter.

inputLabel string

The label of the input.

Returns

int

The corresponding input index.

Examples

var dummy = engine.GetDummy("dummy1");
int index = dummy.MatrixGetInputIndexFromInputLabel("Example Matrix", "Input 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.

The returned index is in the range 1..nrOfInputs.

Exceptions

DataMinerException

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