Method GetParameterDisplay

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

GetParameterDisplay(int)

Gets the display value of the specified standalone parameter.

public virtual string GetParameterDisplay(int pid)

Parameters

pid int

The ID of the standalone parameter.

Returns

string

The display value of the specified standalone parameter.

Examples

var dummy = engine.GetDummy("dummy1");
var displayValue = dummy.GetParameterDisplay(40);

Remarks

Useful for discrete parameters.

Exceptions

DataMinerException

The specified parameter was not found.
-or-
The specified parameter is incorrect.

GetParameterDisplay(int, string)

Gets the display value of the specified table cell.

public virtual string GetParameterDisplay(int pid, string idx)

Parameters

pid int

The ID of the column parameter.

idx string

The primary key or display key.

Returns

string

The display value of the specified table cell or "Not Initialized" if the specified row was not found.

Examples

var dummy = engine.GetDummy("dummy1");
var displayValue = dummy.GetParameterDisplay(1004, "1");

Remarks

Useful for discrete parameters.

Exceptions

DataMinerException

The specified parameter was not found.
-or-
The specified parameter is incorrect.

GetParameterDisplay(string)

Gets the display value of the specified standalone parameter.

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 GetParameterDisplay(string name)

Parameters

name string

The name of the standalone parameter.

Returns

string

The display value of the specified standalone parameter.

Examples

var dummy = engine.GetDummy("dummy1");
var displayValue = dummy.GetParameterDisplay("MyParam");

Remarks

The specified value for the name argument should be the value of the Description tag of the parameter and not the value of the Name tag.

Useful for discrete parameters.

Exceptions

DataMinerException

The specified parameter was not found.
-or-
The specified parameter is incorrect.

GetParameterDisplay(string, string)

Gets the display value of the specified table cell.

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 GetParameterDisplay(string name, string idx)

Parameters

name string

The name of the column parameter.

idx string

The primary key or display key.

Returns

string

The display value of the specified table cell or "Not Initialized" if the specified row was not found.

Examples

var dummy = engine.GetDummy("dummy1");
var displayValue = dummy.GetParameterDisplay("MyColumn", "1");

Remarks

The specified value for the name argument should be the value of the Description tag of the parameter and not the value of the Name tag.

Useful for discrete parameters.

Exceptions

DataMinerException

The specified parameter was not found.
-or-
The specified parameter is incorrect.