IPWorks IoT 2020 ActiveX Edition

Questions / Feedback?

ClientId Property

A string that uniquely identifies this instance of the control to the server.

Syntax

mqttcontrol.ClientId[=string]

Default Value

""

Remarks

The ClientId string is used by the server to uniquely identify each client that is connected to it. In MQTT 5, when the SessionExpInterval config is set to a positive value, the server will also associate it with any session state data that needs to be saved for the length of time specified when the control is disconnected.

If ClientId is empty when Connect is called, the control's behavior depends on value of CleanSession. If CleanSession is True, the control will automatically generate a unique value for ClientId before connecting. If CleanSession is False, the control fails with an error.

This property is not available at design time.

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks IoT 2020 ActiveX Edition - Version 20.0 [Build 8265]