Method GetReadParameterIDFromWrite

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

GetReadParameterIDFromWrite(int)

Gets the ID of the read parameter that corresponds with the specified write parameter ID.

public virtual int GetReadParameterIDFromWrite(int pid)

Parameters

pid int

The ID of the write parameter.

Returns

int

The ID of the corresponding read parameter. Returns -1 in case the specified parameter was not found or if there is no corresponding write parameter.

Examples

var dummy = engine.GetDummy("dummy1");
int readParameterId = dummy.GetReadParameterIDFromWrite(101);

GetReadParameterIDFromWrite(string)

Gets the ID of the read parameter that corresponds with the specified write parameter ID.

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

Parameters

name string

The name of the write parameter.

Returns

int

The ID of the corresponding read parameter. Returns -1 in case the specified parameter was not found or if there is no corresponding write parameter.

Examples

var dummy = engine.GetDummy("dummy1");
int readParameterId = dummy.GetReadParameterIDFromWrite("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.