From f89bca0fb903a9fe6829c41fda105c5ffae8e800 Mon Sep 17 00:00:00 2001 From: Nikunj Patel Date: Tue, 7 Mar 2023 09:36:26 +0100 Subject: [PATCH] Adding ControlObjectClient_cancelWithValue --- src/iec61850/inc/iec61850_client.h | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/src/iec61850/inc/iec61850_client.h b/src/iec61850/inc/iec61850_client.h index 852f2192..190c6bce 100644 --- a/src/iec61850/inc/iec61850_client.h +++ b/src/iec61850/inc/iec61850_client.h @@ -2190,6 +2190,19 @@ ControlObjectClient_selectWithValue(ControlObjectClient self, MmsValue* ctlVal); LIB61850_API bool ControlObjectClient_cancel(ControlObjectClient self); +/** + * \brief Send a cancel command to the server + * + * The cancel command can be used to stop an ongoing operation (when the server and application + * support this) and to cancel a former select command. + * + * \param self the control object instance to use + * \param ctlVal the control value (for APC the value may be either AnalogueValue (MMS_STRUCT) or MMS_FLOAT/MMS_INTEGER + * + * \return true if operation has been successful, false otherwise. + */ +LIB61850_API bool +ControlObjectClient_cancelWithValue(ControlObjectClient self, MmsValue* ctlVal); /** * \brief Send an operate command to the server - async version