aslistarrays - enumerate known arrays


SYNOPSIS

       #include <arraysvcs.h>

       asarraylist_t *aslistarrays(asserver_t Server);


DESCRIPTION

       The  aslistarrays  function  returns  a list of all arrays
       that are known to the  specified  array  services  daemon.
       The  machine  invoking  this  function may or may not be a
       member or one or more of those arrays.

       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 array is described by an asarray_t structure, and the
       entire list is contained in  an  asarraylist_t  structure.
       Both  of  these are defined in <arraysvcs.h>.  The storage
       for these structures is allocated using malloc(3) and  can
       be released using asfreearraylist(3X).


NOTES

       aslistarrays  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),  asfreearraylist(3X), aslistmachines(3X),
       asopenserver(3X).


DIAGNOSTICS

       aslistarrays returns a pointer to an asarraylist_t  struc­
       ture if successful.  If unsuccessful, NULL is returned and
       aserrorcode(3X) is set appropriately.


Man(1) output converted with man2html