pips_group_get_member_name()

Updated: May 06, 2022

Get a group member's name

Synopsis:

#include <pips/publication.h>
const char* pips_group_get_member_name(pips_group_t *const self,
                                       pips_topic_t *const topic)

Arguments:

self
A pointer to a group topic
topic
A pointer to the topic associated with a member of the specified group

Library:

pips-client

Description:

This function retrieves the name assigned to the member of the given group associated with the given topic. The member name is the name that was provided when the member was added using pips_group_add_member(). If no name was provided, the member name is the topic name.

Returns:

On success, a pointer to an immutable string containing the name of the group member associated with the given topic. On error, NULL (errno is set).

Errors:

  • ENODEV: The group argument (self) is invalid.
  • EINVAL: The member topic argument (topic) is invalid.
  • ENOTTY: The topic in self isn't a group.
  • ENOENT: The group doesn't have a member associated with the given topic.