setParametersResult QML Value Type
A true value of the same index indicates that the parameter was set successfully. A false value indicates the change was rejected. More...
| Import Statement: | import QtRos2.RclInterfaces |
| Status: | Experimental Extension |
Properties
- reason : string
- successful : bool
Detailed Description
setParametersResult is a structured value type usable in QML. It maps directly to the rcl_interfaces::msg::SetParametersResult ROS 2 message type.
Construct a setParametersResult in QML by assigning a JavaScript object whose keys are its component properties, or by setting those properties individually.
See also SetParametersResultPublisher and SetParametersResultSubscriber.
Property Documentation
reason : string
Reason why the setting was a failure. On success, the contents of this field
are undefined. This should only be used for logging and user interfaces.
successful : bool
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.
