Method ClearParameter

Namespace: Skyline.DataMiner.Scripting

Assembly: SLManagedScripting.dll

ClearParameter(int)

Clears a parameter and also the display value of the parameter. If the parameter is saved the change also gets saved. This works for both tables as well as single parameter, but not for table columns.

int ClearParameter(int parameterId)

Parameters

parameterId int: The ID of the parameter.

Returns

int: HRESULT indicating success or failure of clearing. If failure occurs because of an invalid parameter ID an exception will be thrown instead.

Remarks

Performs an NotifyProtocol 474 NT_CLEAR_PARAMETER call with wrapping to throw an argumentException if the clear cannot execute due to an invalid parameter ID (e.g. for a table column).

Exceptions