Function rcutils_string_map_key_exists

Function Documentation

bool rcutils_string_map_key_exists(const rcutils_string_map_t *string_map, const char *key)

Get whether or not a key exists.

The key needs to be a null terminated c string.

This function can fail and return false if the key is not found, or the string_map is NULL or invalid, or if the key is NULL. In all cases no error message is set.

Parameters:
  • string_map[in] rcutils_string_map_t to be searched

  • key[in] map key, must be null terminated c string

Returns:

true if key is in the map, or

Returns:

false if key is not in the map, or

Returns:

false for invalid arguments, or

Returns:

false if the string map is invalid.