asgetdfltarray(3x)

NAME
     asgetdfltarray - get information about the default array

SYNOPSIS
     #include <arraysvcs.h>

     asarray_t* asgetdfltarray(asserver_t Server);

DESCRIPTION
     The asgetdfltarray function returns a description of the array that will
     be used by the array services daemon for commands and other operations if
     no other array has been specified.  The description is in the form of an
     asarray_t structure, which is defined in <arraysvcs.h>.  The storage for
     this structure is allocated using malloc(3) and can be released using
     asfreearray(3X).

     The Server parameter specifies an optional array server token, which can
     be used to direct the request to a specific 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).

NOTES
     asgetdfltarray 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), asfreearray(3X), aslistarrays(3X), asopenserver(3X).

DIAGNOSTICS
     asgetdfltarray returns a pointer to an asarray_t structure if successful,
     or NULL if not.  If unsuccessful, aserrorcode(3X) will be set
     appropriately.