mqttPendingClear (Function)

This function will clear the queue of pending messages.

Input:

handle : INT

The handle to the MQTT connection.

Returns: SINT

Declaration:

FUNCTION mqttPendingClear : SINT;
VAR_INPUT
  handle   : INT;
END_VAR;

Example:

INCLUDE rtcu.inc
 
VAR
  mqtt : INT;
END_VAR;
 
PROGRAM test;
 
BEGIN
  ...
  // Clear any pending messages
  IF mqttPendingCount(handle:=mqtt) > 0 THEN
    mqttPendingClear(handle:=mqtt);
  END_IF;
  ...
END;
 
END_PROGRAM;