pips_group_next_member()

Get the next member in a group

Synopsis:

#include <pips/publication.h>
pips_group_member_t* pips_group_next_member(pips_group_t *const group_hdl,
                                            pips_group_member_t *const current)

Arguments:

group_hdl
A pointer to a group handle
current
A pointer to a group member handle representing the current member

Library:

pips-client

Description:

This function can be used to iterate over the members of a group. The first invocation should be given the NULL pointer as the current argument; in this case, the first element of the group will be returned. Subsequent invocations can be given the handle of the member last returned by this function; the next member will then be returned.

This function can accommodate members being added to or removed from the group between calls.

Returns:

On success, a handle to the next member in the group. If there are no more members or an error occurred, the function returns NULL and sets errno.

Errors:

  • ENODEV: The group is invalid.
  • ENOENT: There are no more members in the group.
Page updated: