Table of Contents

Method SetParameterByName

Namespace
Skyline.DataMiner.Scripting
Assembly
SLManagedScripting.dll

SetParameterByName(string, object)

Sets the parameter with the specified name to the specified value.

int SetParameterByName(string name, object value)

Parameters

name string

The name of the parameter.

value object

The value to set.

Returns

int

HRESULT value. A value of 0 (S_OK) indicates the set succeeded.

Examples

int result = protocol.SetParameterByName("myParameter", "myValue");

Remarks

  • This is a wrapper method for the NotifyProtocol type 84 NT_SET_PARAMETER_BY_NAME call.
  • In case there are both a read and write parameter with the specified name, the set will be performed on the write parameter.In case the read parameter needs to be set, use the SetReadParameterByName(string, object) method instead.
  • In case multiple parameters need to be set, it is preferred to use a single SetParametersByName method call in order to reduce the inter-process communication between the SLScripting and SLProtocol processes.