Function rcl_action_client_get_action_name

• Defined in File action_client.h

Function Documentation

const char *rcl_action_client_get_action_name(const rcl_action_client_t *action_client)

Get the name of the action for a rcl_action_client_t.

This function returns the action client’s name string. This function can fail, and therefore return NULL, if the:

• action client is NULL

• action client is invalid (never called init, called fini, or invalid)

The returned string is only valid as long as the action client is valid. The value of the string may change if the topic name changes, and therefore copying the string is recommended if this is a concern.

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

Parameters:

action_client – [in] the pointer to the action client

Returns:

name string if successful, otherwise NULL