67 / 79Issued: 19.12.2012 Version: KST EthernetKRL 2.2 V1 en (PDF)
9 Appendix
9.4.5 Checking a function for errors
9.4.6 Clearing, locking, unlocking and checking a memory
EKI_CHECK( EKI_STATUS, EKrlMsgType, CHAR[])
Function Checks whether an error occurred during execution of
an EthernetKRL function:
The error number is read out and the correspond-
ing message is displayed on the smartHMI. (Pa-
rameter 1)
Optional: If the channel name is specified, it is
checked during data reception whether errors have
occurred. (Parameter 3)
Parameter 1 EKI_STATUS
Return values of the checked function (>>> "Return
values" Page 36)
Parameter 2 Type: ENUM
Type of message displayed on the smartHMI:
#NOTIFY: Notification message
#STATE: Status message
#QUIT: Acknowledgement message
#WAITING: Wait message
Parameter 3
(optional)
Type: CHAR
Name of the open channel
Example 1 EKI_CHECK(RET,#QUIT)
Example 2 EKI_CHECK(RET,#NOTIFY,"MyChannelName")
RET = EKI_ClearBuffer(CHAR[], CHAR[])
Function Deletes data which have been received but not yet
called up from a memory
Parameter 1 Type: CHAR
Name of channel
Parameter 2 Type: CHAR
Position of the memory or all memories
(>>> 6.2.6 "Deleting received data" Page 35)
RET Type: EKI_STATUS
Return values of the function (>>> "Return values"
Page 36)
Example 1 RET = EKI_ClearBuffer("Channel_1", "Root/Activ/
Flag")
Example 2 RET = EKI_ClearBuffer("Channel_1", "Root")
RET = EKI_Lock(CHAR[])
Function Disables the processing of received data, i.e. the data
can no longer be stored in the memory.