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.

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.

Remarks

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

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.")]
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.

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.