Method SetParametersIndexByKey

Namespace

Skyline.DataMiner.Scripting

Assembly

SLManagedScripting.dll

SetParametersIndexByKey(int[], string[], int[], object[], DateTime[])

Sets the value of cells in tables, identified by their primary key and 1-based column position, with the specified values.

object SetParametersIndexByKey(int[] ids, string[] keys, int[] iYs, object[] values, DateTime[] timeInfos)

Parameters

ids int[]

The IDs of the table parameters.

keys string[]

The primary keys of the rows.

iYs int[]

The 1-based positions of the columns.

values object[]

The values to set.

timeInfos DateTime[]

Timestamps.

Returns

object

This method call can return an unsigned integer error code, e.g. when the size of the ids array does not match the size of the values array.Otherwise a uint[] is returned that has the same size as the ids array containing the HRESULT value.At each position, this array contains the result value as would be returned when performing a SetParameterIndexByKey call on the individual cell.In case the value in the array is 262730 (0x0004024AL), this indicates the cell value changed.

Remarks

• Prior to DataMiner 10.2.7 (RN 33198), the SetParametersIndexByKey method cannot be used to update a single cell. In case a single cell must be updated, use the SetParameterIndexByKey method instead. In cases where you dynamically set a number of cells, make sure to check the number of cells that will need to be updated. In case multiple cells need to be updated, use the SetParametersIndexByKey method. If a single cell needs to be updated, use the SetParameterIndexByKey method.
• Feature introduced in DataMiner version 8.0.3.
• This method should only be used in case multiple distinct cells need to be set(e.g., cells in different tables). When appropriate, use the SetRow, FillArray, FillArrayNoDelete, NotifyProtocol type 220 call, etc.to set multiple cells belonging to the same row, column or table, respectively.
• This method acts as a wrapper for a NotifyProtocol type 121 NT_PUT_PARAMETER_INDEX call.
• From DataMiner 10.2.9 onwards (RN 33849), if the DateTime.Kind property of an entry in timeInfos is unspecified, the timestamp of that entry will be handled as local time.
• The sets are processed in the order that they appear within the provided arrays.

SetParametersIndexByKey(int[], string[], int[], object[])

Sets the value of cells in tables, identified by their primary key and 1-based column position, with the specified values.

object SetParametersIndexByKey(int[] ids, string[] keys, int[] iYs, object[] values)

Parameters

ids int[]

The IDs of the table parameters.

keys string[]

The primary keys of the rows.

iYs int[]

The 1-based positions of the columns.

values object[]

The values to set.

Returns

object

This method call can return an unsigned integer error code, e.g. when the size of the ids array does not match the size of the values array.Otherwise a uint[] is returned that has the same size as the ids array containing the HRESULT value. At each position, this array contains the result value as would be returned when performing a SetParameterIndexByKey call on the individual cell.In case the value in the array is 262730 (0x0004024AL), this indicates the cell value changed.

Remarks

• Prior to DataMiner 10.2.7 (RN 33198), the SLProtocol.SetParametersIndexByKey method cannot be used to update a single cell. In case a single cell must be updated, use the SetParameterIndexByKey method instead. In cases where you dynamically set a number of cells, make sure to check the number of cells that will need to be updated. In case multiple cells need to be updated, use the SetParametersIndexByKey method. If a single cell needs to be updated, use the SetParameterIndexByKey method.
• Feature introduced in DataMiner version 8.0.3.
• This method should only be used in case multiple distinct cells need to be set(e.g., cells in different tables). When appropriate, use the SetRow, FillArray, FillArrayNoDelete, NotifyProtocol type 220 call, etc.to set multiple cells belonging to the same row, column or table, respectively.
• This method acts as a wrapper for a NotifyProtocol type 121 NT_PUT_PARAMETER_INDEX call.
• The sets are processed in the order that they appear within the provided arrays.