Spread 4.0.0 C API

SP_get_vs_set_members
 
int SP_get_vs_set_members (const char *memb_mess, 
                           const vs_set_info *vs_set, 
                           char member_names[][MAX_GROUP_NAME],
                           int member_names_count);

int SP_scat_get_vs_set_members (const scatter *memb_mess_scat, 
                                const vs_set_info *vs_set, 
                                char member_names[][MAX_GROUP_NAME],
                                int member_names_count);


Parameters
  memb_mess membership message to extract vs set members from
  memb_mess_scat scatter membership message to extract vs set members from
  vs_set vs_set to extract members from
  member_names arrary to receive copy of vs_set members into
  member_names_count count of the number of member names the member_names array can hold


Return Values
  > 0 Success (returns the number of members copied)
  BUFFER_TOO_SHORT The passes in member_names array was too small to handle all the member_names contained in vs_set. No data is parsed. Reallocate a larger array of member names (the required number is available in the corresponding vs_set_info struct) and call this function again.


Description
  SP_get_vs_set_members and its scatter variant extract the list of members of a particular VS set. The members are stored into an array of strings, each of which is MAX_GROUP_NAME characters in length. The number of strings (names) in the array should be provided in the member_names_count parameter.

The memb_mess field or scatter field should be the body of a message that was returned in a previous SP_receive call for a membership message.



Requirements
  Header: Include sp.h
Library: Use libspread
Version: 4.0


Also See
  spread programmer's reference , SP_get_vs_sets_info, SP_get_memb_info, SP_receive