Method FindDisplayKey

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

FindDisplayKey(int, string)

Gets the display key that corresponds with the specified primary key.

public virtual string FindDisplayKey(int pid, string primaryKey)

Parameters

pid int

The ID of the table or column parameter.

primaryKey string

The primary key.

Returns

string

The display key that corresponds with the specified primary key or null if not found.

Examples

var dummy = engine.GetDummy("dummy1");
string displayKey = dummy.FindDisplayKey(1000, "1");

FindDisplayKey(string, string)

Gets the display key that corresponds with the specified primary key.

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 FindDisplayKey(string parameterName, string primaryKey)

Parameters

parameterName string

The name of the table or column parameter.

primaryKey string

The primary key.

Returns

string

The display key that corresponds with the specified primary key or null if not found.

Examples

var dummy = engine.GetDummy("dummy1");
string displayKey = dummy.FindDisplayKey("Overview", "1");

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.