aslistmachines - enumerate machines in an array


SYNOPSIS

       #include <arraysvcs.h>

       asmachinelist_t *aslistmachines(asserver_t Server, const char *Name);


DESCRIPTION

       The aslistmachines function returns a list of the machines
       that are members of the array specified by Name.  If  Name
       is  NULL,  the  machines  that  are members of the default
       array is returned.

       The Server parameter specifies an  optional  array  server
       token,  which  can be used to direct the request to a spe­
       cific  array  services  daemon.   If  NULL  is   specified
       instead,  the  request  will  be  processed by the default
       array services daemon (see array(1) for  more  information
       on  how  the  default  array services daemon is selected).
       For more details on creating an array  server  token,  see
       asopenserver(3X).

       Each machine is described by an asmachine_t structure, and
       the entire list is contained in an asmachinelist_t  struc­
       ture.   Both  of  these are defined in <arraysvcs.h>.  The
       storage for these structures is allocated using  malloc(3)
       and can be released using asfreemachinelist(3X).


NOTES

       aslistmachines  is found in the library "libarray.so", and
       will be loaded if the option "-larray" is used with  cc(1)
       or ld(1).


SEE ALSO

       aserrorcode(3X),  asfreemachinelist(3X), aslistarrays(3X),
       asopenserver(3X).


DIAGNOSTICS

       aslistmachines returns a  pointer  to  an  asmachinelist_t
       structure   if   successful.   If  unsuccessful,  NULL  is
       returned and aserrorcode(3X) is set appropriately.


Man(1) output converted with man2html