Function rosidl_runtime_c_type_description_utils_append_field

• Defined in File type_description_utils.h

Function Documentation

rcutils_ret_t rosidl_runtime_c_type_description_utils_append_field(rosidl_runtime_c__type_description__IndividualTypeDescription *individual_type_description, rosidl_runtime_c__type_description__Field *field)

Append a Field to an IndividualTypeDescription, extending the sequence.

Ownership:

• A deep-copy of the field is appended to individual_type_description on success, the individual_type_description is then responsible for freeing the copied field.

• The ownership of the input field is not transferred, it must still be freed.

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

Parameters:

• individual_type_description – [inout] the individual type description to append to, noop on failure

• field – [inout] the field to append

Returns:

#RCUTILS_RET_OK if successful, or

Returns:

#RCUTILS_RET_BAD_ALLOC if memory allocation fails, or

Returns:

#RCUTILS_RET_INVALID_ARGUMENT for invalid arguments, or

Returns:

#RCUTILS_RET_ERROR if an unknown error occurs.