Method MatrixGetLockMode

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

MatrixGetLockMode(int, bool, int)

Gets a value indicating whether the specified input or output is locked.

bool MatrixGetLockMode(int pid, bool input, int index)

Parameters

pid int

The ID of the matrix parameter.

input bool

true if the specified index is an input; otherwise, false.

index int

The index of the input or output.

Returns

bool

The label of the specified matrix input or output.

Remarks

index must be in the range 1..nrOfInputs if input is true.

index must be in the range 1..nrOfOutputs if input is false.

MatrixGetLockMode(int, bool, string)

Gets a value indicating whether the specified input or output is locked.

bool MatrixGetLockMode(int pid, bool input, string label)

Parameters

pid int

The ID of the matrix parameter.

input bool

true if the specified index is an input; otherwise, false.

label string

The label of the input or output.

Returns

bool

The label of the specified matrix input or output.

MatrixGetLockMode(string, bool, string)

Gets a value indicating whether the specified input or output is locked.

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.")]
bool MatrixGetLockMode(string parameterName, bool input, string label)

Parameters

parameterName string

The name of the matrix parameter.

input bool

true if the specified index is an input; otherwise, false.

label string

The label of the input or output.

Returns

bool

The label of the specified matrix input or output.

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.

MatrixGetLockMode(string, bool, int)

Gets a value indicating whether the specified input or output is locked.

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.")]
bool MatrixGetLockMode(string parameterName, bool input, int index)

Parameters

parameterName string

The name of the matrix parameter.

input bool

true if the specified index is an input; otherwise, false.

index int

The index of the input or output.

Returns

bool

The label of the specified matrix input or output.

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 if input is true.

index must be in the range 1..nrOfOutputs if input is false.