Function rcutils_hash_map_fini

• Defined in File hash_map.h

Function Documentation

rcutils_ret_t rcutils_hash_map_fini(rcutils_hash_map_t *hash_map)

Finalize the previously initialized hash_map struct.

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

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

Parameters:

hash_map – [inout] rcutils_hash_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.