Function rclc_set_parameter_read_only

Defined in File rclc_parameter.h

Function Documentation

rcl_ret_t rclc_set_parameter_read_only(rclc_parameter_server_t *parameter_server, const char *parameter_name, bool read_only)

Sets a parameter read only flag. Read only parameters can only be modified from the rclc_parameter_set API. This method is disabled on user callback execution.

Attribute	Adherence
Allocates Memory	No
Thread-Safe	No
Uses Atomics	No
Lock-Free	No

Parameters:

parameter_server – [in] preallocated rclc_parameter_server_t
parameter_name – [in] name of the parameter
read_only – [in] read only flag

Returns:

RCL_RET_OK if success