MQTTSubscribeProperties (STRUCT)¶

TYPE MQTTSubscribeProperties : STRUCT

Subscribe properties (MQTT V5)

InOut:

Name	Type	Comment
`udiSubscriptionIdentifier`	`UDINT`	The subscription identifier will be returned on the message when it is delivered. This allows the Client to determine which subscription or subscriptions caused the message to be delivered. Setting the identifier accelerates the filtering of the telegrams in the subscriber function block.
`udiCorrelationDataSize`	`UDINT`	Size of the correlation data receive buffer \|paCorrelationData\|
`paCorrelationData`	POINTER TO BYTE	Pointer to correlation data reveive buffer. The Correlation Data is used by the sender of the Request Message to identify which request the Response Message is for when it is received.
`userProperties`	ARRAY [0..(MQTTParam.g_udiMaxUserProperties - 1)] OF MQTTStringPair	User defined properties
`xNoLocalOption`	`BOOL`	No Local option If the value is TRUE, Application Messages MUST NOT be forwarded to a connection with a ClientID equal to the ClientID of the publishing connection
`xRetainAsPublished`	`BOOL`	Retain As Published option If TRUE, Application Messages forwarded using this subscription keep the RETAIN flag they were published with.
`eRetainHandling`	MQTT_RETAIN_HANDLING	This option specifies whether retained messages are sent when the subscription is established.