Table of Contents

Method FindParameterID

Namespace
Skyline.DataMiner.Automation
Assembly
SLManagedAutomation.dll

FindParameterID(string)

Gets the ID that corresponds with the specified parameter name.

note

Please use a library with the mapping between parameter Description and ID in your script instead.

[Obsolete("Use a library with the mapping between name and ID in your script instead.")]
public virtual int FindParameterID(string name)

Parameters

name string

The name of the parameter.

Returns

int

The ID that corresponds with the specified parameter name or -1 if the parameter was not found.

Examples

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

FindParameterID(string, bool)

Gets the ID that corresponds with the specified parameter name.

note

Please use a library with the mapping between parameter Description and ID in your script instead.

[Obsolete("Use a library with the mapping between name and ID in your script instead.")]
public virtual int FindParameterID(string name, bool writeParam)

Parameters

name string

The name of the parameter.

writeParam bool

true if the specified parameter is a write parameter; otherwise, false.

Returns

int

The ID that corresponds with the specified parameter name or -1 if the parameter was not found.

Examples

var dummy = engine.GetDummy("dummy1");
int parameterId = dummy.FindParameterID("MyParameter", true);

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.