Method MatrixSetInputLabel

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixSetInputLabel(int, int, string)

Sets the label of the specified input.

public virtual void MatrixSetInputLabel(int pid, int index, string newName)

Parameters

pid int

The ID of the matrix parameter.

index int

The index of the input.

newName string

The new input label.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixSetInputLabel(1000, 10, "Main");

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.

MatrixSetInputLabel(int, string, string)

Sets the label of the specified input.

public virtual void MatrixSetInputLabel(int pid, string oldName, string newName)

Parameters

pid int

The ID of the matrix parameter.

oldName string

The label of the input.

newName string

The new input label.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixSetInputLabel(1000, "Input 1", "Main");

Exceptions

DataMinerException

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

MatrixSetInputLabel(string, int, string)

Sets the label of the specified input.

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 void MatrixSetInputLabel(string parameterName, int index, string newName)

Parameters

parameterName string

The name of the matrix parameter.

index int

The index of the input.

newName string

The new input label.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixSetInputLabel("Example Matrix", 10, "Main");

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.

MatrixSetInputLabel(string, string, string)

Sets the label of the specified input.

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 void MatrixSetInputLabel(string parameterName, string oldName, string newName)

Parameters

parameterName string

The name of the matrix parameter.

oldName string

The label of the input.

newName string

The new input label.

Examples

var dummy = engine.GetDummy("dummy1");
dummy.MatrixSetInputLabel("Example Matrix", "Input 1", "Main");

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