Method MatrixGetOutputLabel

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixGetOutputLabel(int, int)

Gets the label of the specified matrix output.

public virtual string MatrixGetOutputLabel(int pid, int index)

Parameters

pid int

The ID of the matrix parameter.

index int

The output index.

Returns

string

The label of the specified matrix output.

Examples

var dummy = engine.GetDummy("dummy1");
string label = dummy.MatrixGetOutputLabel(1000, 10);

Remarks

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

Exceptions

DataMinerException

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

MatrixGetOutputLabel(string, int)

Gets the label of the specified matrix output.

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 string MatrixGetOutputLabel(string parameterName, int index)

Parameters

parameterName string

The name of the matrix parameter.

index int

The output index.

Returns

string

The label of the specified matrix output.

Examples

var dummy = engine.GetDummy("dummy1");
string label = dummy.MatrixGetOutputLabel("Example Matrix", 10);

Remarks

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

Exceptions

DataMinerException

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