Function rcl_convert_type_description_msg_to_runtime

• Defined in File type_description_conversions.h

Function Documentation

rosidl_runtime_c__type_description__TypeDescription *rcl_convert_type_description_msg_to_runtime(const type_description_interfaces__msg__TypeDescription *description_msg)

Convert type description msg struct to a rosidl runtime struct.

This function converts a type_description_interfaces/msg/TypeDescription to the corresponding rosidl_runtime_c__type_description__TypeDescription struct. The retrieved pointer shall be destroyed with rosidl_runtime_c__type_description__TypeDescription__destroy() after use.

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

Parameters:

description_msg – [in] the pointer to the msg type description struct

Returns:

a valid pointer to the runtime struct, or

Returns:

NULL if an unspecified error occurs.