Method SendToDisplay
SendToDisplay(int, int[], int[])
Makes the SLElement process update the specified parameter.
int SendToDisplay(int iID, int[] iXs, int[] iYs)
Parameters
iID
intThe ID of the parameter to update.
iXs
int[]The 1-based inputs.
iYs
int[]The 1-based outputs.
Returns
- int
HRESULT value. A value of 0 (S_OK) indicates the set succeeded.
Remarks
- This is a wrapper method for the NotifyProtocol type 123 NT_NOTIFY_DISPLAY call.
- When SendToDisplay(int parameterID) is used on a matrix, this will update the entire matrix. This is also the case when input is set to 0 or -1 and output to 0 or -1.
- It is advised to use one of the overloads providing the input(s) and output(s) when possible(i.e.when it is known which crosspoints have been updated) to reduce the load.
- The overloads accepting one or multiple input and output indices were introduced in DataMiner version 9.0.0 (RN 12434, RN 12487).
-
In case of a 2x10 matrix, for example, the coordinates of the top-left crosspoint are iX=1/iY=1, and the coordinates of the bottom-right crosspoint are iX = 2 / iY = 10.
SendToDisplay(int, int, int)
Makes the SLElement process update the specified parameter.
int SendToDisplay(int iID, int iX, int iY)
Parameters
Returns
- int
HRESULT value. A value of 0 (S_OK) indicates the set succeeded.
Examples
protocol.SendToDisplay(1000, 1, 1);
Remarks
- This is a wrapper method for the NotifyProtocol type 123 NT_NOTIFY_DISPLAY call.
- When SendToDisplay(int parameterID) is used on a matrix, this will update the entire matrix. This is also the case when input is set to 0 or -1 and output to 0 or -1.
- It is advised to use one of the overloads providing the input(s) and output(s) when possible(i.e.when it is known which crosspoints have been updated) to reduce the load.
- The overloads accepting one or multiple input and output indices were introduced in DataMiner version 9.0.0 (RN 12434, RN 12487).
-
In case of a 2x10 matrix, for example, the coordinates of the top-left crosspoint are iX=1/iY=1, and the coordinates of the bottom-right crosspoint are iX = 2 / iY = 10.
SendToDisplay(int)
Makes the SLElement process update the specified parameter.
int SendToDisplay(int iID)
Parameters
iID
intThe ID of the parameter to update.
Returns
- int
HRESULT value. A value of 0 (S_OK) indicates the set succeeded.
Examples
protocol.SendToDisplay(1000);
Remarks
- This is a wrapper method for the NotifyProtocol type 123 NT_NOTIFY_DISPLAY call.
- When SendToDisplay(int parameterID) is used on a matrix, this will update the entire matrix. This is also the case when input is set to 0 or -1 and output to 0 or -1.
- It is advised to use one of the overloads providing the input(s) and output(s) when possible(i.e.when it is known which crosspoints have been updated) to reduce the load.