Index for Section 3

Alphabetical listing for A

Bottom of page

advfs_get_fset_list(3)
NAME
  advfs_get_fset_list - Obtain a list of all the filesets in an AdvFS file
  domain

SYNOPSIS
  #include <sys/advfs_syscalls.h>

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

LIBRARY
  AdvFS Library (libadvfs)

PARAMETERS
  domain
      The name of the AdvFS file domain to be searched for filesets.

  arraySize
      Contains the number of filesetInfoT cells that have been malloced for
      the filesetInfo array.

  *offset
      A pointer for the next iteration of the function:	 the starting
      location for the next set of filesets.

  *numFilesets
      The total number of filesets in the specified file domain.

  filesetInfo[]
      The array of fileset information structures that is filled in on
      successful return from this function.

DESCRIPTION
  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
  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
  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
  [EACCES]
      The calling program is not running with root privileges.

  [EIO]
      An I/O error occurred on one of the disks in the file domain.

  [ENOENT]
      The file domain specified by the domain parameter does not exist.

  [ENOMEM]
      There is not enough memory available for the operation

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

  Functions: advfs_clonefset(3), advfs_rmfset(3)

Index for Section 3

Alphabetical listing for A

Top of page