Function rcutils_string_map_fini

• Defined in File string_map.h

Function Documentation

rcutils_ret_t rcutils_string_map_fini(rcutils_string_map_t *string_map)

Finalize the previously initialized string map struct.

This function will free any resources which were created when initializing or when calling rcutils_string_map_set().

Parameters:

string_map – [inout] rcutils_string_map_t to be finalized

Returns:

RCUTILS_RET_OK if successful, or

Returns:

RCUTILS_RET_INVALID_ARGUMENT for invalid arguments, or

Returns:

RCUTILS_RET_ERROR if an unknown error occurs.