NAME    [Toc]    [Back]

       advfs_get_fset_list - Obtain a list of all the filesets in
       an AdvFS file domain

SYNOPSIS    [Toc]    [Back]

       #include <sys/advfs_syscalls.h>

       int advfs_get_fset_list(
               char domain,
               unsigned long arraySize,
               unsigned long *offset,
               unsigned long *numFilesets,
               filesetInfoT filesetInfo[] );

LIBRARY    [Toc]    [Back]

       AdvFS Library (libadvfs)

PARAMETERS    [Toc]    [Back]

       The name of the AdvFS file domain to be searched for filesets.
  Contains the number of filesetInfoT cells that have
       been malloced for the filesetInfo array.   A  pointer  for
       the next iteration of the function:  the starting location
       for the next set of filesets.  The total number  of  filesets
  in  the specified file domain.  The array of fileset
       information structures that is  filled  in  on  successful
       return from this function.

DESCRIPTION    [Toc]    [Back]

       Use this function to obtain information about the filesets
       in an AdvFS file domain.  Information about  both  mounted
       and  unmounted  filesets is returned. The function returns
       the information in the "filesetInfo[]" array.

       For an  example  of  programming  the  advfs_get_fset_list
       function, see [reference to be provided].

NOTES    [Toc]    [Back]

       We  recommend  that  the application malloc an array large
       enough to gather all fileset information in a single  call
       to the function.

       The  function  can  skip  filesets or return them multiple
       times if the function is using the offset parameter  while
       another  user  creates  or removes filesets in between the
       calls that this user makes to the function.

       This function can take a very long time to  complete  when
       it is called to execute on a file domain with a large number
 of unmounted filesets.

RETURN VALUES    [Toc]    [Back]

       The function returns a value of  0  (zero)  on  successful
       completion.  The function returns a value of -1 on failure
       and sets the value of errno to the specific error.

ERRORS    [Toc]    [Back]

       The calling program is not running with  root  privileges.
       An  I/O  error  occurred  on  one of the disks in the file
       domain.  The file domain specified by the domain parameter
       does  not exist.  There is not enough memory available for
       the operation

SEE ALSO    [Toc]    [Back]

       Commands:  clonefset(8),  mkfset(8),  renamefset(8),  rmfset(8)

       Functions: advfs_clonefset(3), advfs_rmfset(3)



                                           advfs_get_fset_list(3)