Method GetWriteParameterIDFromRead

Namespace

Skyline.DataMiner.Automation

Assembly

SLManagedAutomation.dll

GetWriteParameterIDFromRead(int)

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

public virtual int GetWriteParameterIDFromRead(int pid)

Parameters

pid int

The ID of the read parameter.

Returns

int

The ID of the corresponding write 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 writeParameterId = dummy.GetWriteParameterIDFromRead(100);

GetWriteParameterIDFromRead(string)

Gets the ID of the write parameter that corresponds with the specified read 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 int GetWriteParameterIDFromRead(string name)

Parameters

name string

The name of the read parameter.

Returns

int

The ID of the corresponding write 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 writeParameterId = dummy.GetWriteParameterIDFromRead("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.