Method GetParameter

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

GetParameter(int)

Gets the value of the specified parameter.

public virtual object GetParameter(int pid)

Parameters

pid int

The ID of the parameter.

Returns

object

The value of the parameter.

Examples

var dummy = engine.GetDummy("dummy1");
var value = dummy.GetParameter(10);

Exceptions

DataMinerException

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

GetParameter(int, string)

Gets the value of the specified table cell.

public virtual object GetParameter(int pid, string idx)

Parameters

pid int

The ID of the column parameter.

idx string

The primary key or display key.

Returns

object

The value of the parameter.

Examples

var dummy = engine.GetDummy("dummy1");
var value = dummy.GetParameter(1000, "1");

Exceptions

DataMinerException

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

GetParameter(string)

Gets the value of the specified 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 object GetParameter(string name)

Parameters

name string

The name of the parameter.

Returns

object

The value of the parameter.

Examples

var dummy = engine.GetDummy("dummy1");
var value = dummy.GetParameter("MyParameter");

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.

Exceptions

DataMinerException

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

GetParameter(string, string)

Gets the 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 object GetParameter(string name, string idx)

Parameters

name string

The name of the column parameter.

idx string

The primary key or display key.

Returns

object

The value of the parameter.

Examples

var dummy = engine.GetDummy("dummy1");
var value = dummy.GetParameter("MyTableColumn", "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.

Exceptions

DataMinerException

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