Clickmsgaddreceivetasktovport – Wavetronix Click 500 (programmable controller) (CLK-500) - Developer Guide User Manual

Page 165

164

APPENDIX • CLICK 500 DEVELOPER GUIDE

ClickMsgAddReceiveTaskToVPort

This function adds a ClickMsgString string to the watch list. However, the callback function

for the associated receive task will only be called if the specified ClickMsgString is received

on the specified port. Use this function to prevent the watch list memory buffers from inter-

leaving partial messages received simultaneously on different virtual ports.

LIBRARY – click500message.LIB

SYNTAX –

bool ClickMsgAddReceiveTaskToVPort(ClickMsgString message,
funcPtr messageTask,
int virt);

PARAMETER1 – message: The ClickMsgString to watch for in the virtual port receive

buffers.

PARAMETER2 – messageTask: A function pointer to the associated call back function.

PARAMETER3 – virt: The virtual port to watch for the message.

RETURN VALUE – bool SUCCESS == 0, if message was succesfully added to the watch

list ERROR == 1, if message was not added