Function rclc_add_parameter_description

Function Documentation

rcl_ret_t rclc_add_parameter_description(rclc_parameter_server_t *parameter_server, const char *parameter_name, const char *parameter_description, const char *additional_constraints)

Add a description to a parameter. (This feature is disabled in low memory mode.) This description will be returned on describe parameters requests.

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

  • parameter_description – [in] description of the parameter

  • additional_constraints – [in] constraints description

  • read_only – [in] read only flag

Returns:

RCL_RET_OK if success