sam_unrearch(3)

NAME
     sam_unrearch - Removes rearchive attributes  on  a  file  or
     directory

SYNOPSIS
     cc [ flag  ... ] file    ...  -L/opt/SUNWsamfs/lib  -lsam  [library ... ]

     #include "/opt/SUNWsamfs/include/lib.h"

     int sam_unrearch(const char *path, int num_opts, ... );

DESCRIPTION
     sam_unrearch() lets you remove a request to rearchive a file
     or  a  directory  using a Sun Storage Archive Manager system
     call.  path is the file on which to remove  the  attributes,
     followed  by  a  sequence  of  num_opts  input characters or
     options.  Individual options are described below.

     For example, if you have used the sam_rearch(3) function  to
     request   that  a  file  be  rearchived,  you  can  use  the
     sam_unrearch  function   to   clear   the   bit   that   the
     sam_rearch(3)  function had set.  The specifications for the
     archive copy (c copy_no) and/or the media type and VSN
     (m media_type  [v vsn])  determine  which  archive  copy  is
     affected.

     There are several ways to remove the  request  to  rearchive
     from  one  or  more archive entries.  These ways are as fol-
     lows:

     o  By copy number

     o  By copy number, media type, and VSN

     o  By copy number and media type

     o  By media type

     o  By media type and VSN

OPTIONS
     c copy_no
          Removes the rearchive request for copy_no.  Specify  1,
          2, 3, or 4 for copy_no.  If one or more 'c' options are
          are  specified,  the  function  removes  the  rearchive
          request from only those archive copies (1, 2, 3, or 4).
          Either a "c copy_no" or a  "m  media"  option  must  be
          specified.

     M    Removes rearchive requests  for  metadata  only.   This
          includes  directories, the segment index, and removable

          media files.  Regular files and symbolic links are  not
          unrearchived.   If you are unarchiving a directory, you
          must specify the "M" option.

     m media
          Removes rearchive requests from all archive  copies  on
          the  specified  media_type.   For  the list of possible
          media_type specifications, see  the  mcf(4)  man  page.
          Either  a  "c  copy_no"  or  a "m media" option must be
          specified.  If you specify a "m media" option, you  can
          also specify a "v vsn" option.

     v vsn
          Removes the rearchive requests for the  archive  copies
          on  vsn.   For vsn, specify a volume serial name (VSN).
          If you specify a "v vsn" option, you must also  specify
          a "m media" option.

RETURN VALUES
     Upon successful completion a value of 0 is returned.  Other-
     wise, a value of -1 is returned and errno is set to indicate
     the error.

ERRORS
     sam_unrearch() fails if one or more  of  the  following  are
     true:

     EINVAL              An invalid option was specified, or  the
                         file  is  neither  a  regular file nor a
                         directory.

     EPERM               Not the owner or superuser.

     EFAULT              Argument points to an illegal address.

     EINTR               A   signal   was   caught   during   the
                         sam_unrearch() function.

     ELOOP               Too many symbolic links were encountered
                         in translating path.

     ENAMETOOLONG        The length of the path argument  exceeds
                         {PATH_MAX}, or the length of a path com-
                         ponent    exceeds    {NAME_MAX}    while
                         {_POSIX_NO_TRUNC} is in effect.

     ENOENT              The named file does not exist or is  the
                         null pathname.

     ENOLINK             path points to a remote machine and  the
                         link   to  that  machine  is  no  longer
                         active.

     ENOTDIR             A component of the path prefix is not  a
                         directory.

SEE ALSO
     unrearch(1m), rearch(1m), sam_rearch(3), mcf(4)