ms_$neighbors — Apollo

MS_$NEIGHBORS                     Domain/OS                      MS_$NEIGHBORS


NAME
     ms_$neighbors - find out if two mapped objects are on the same volume

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/ms.h>

     boolean ms_$neighbors(
          void *&address1,
          void *&address2,
          status_$t *status)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/ms.ins.pas';

     function  ms_$neighbors(
          in address1: univ_ptr;
          in address2: univ_ptr;
          out status: status_$t): boolean;

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/ms.ins.ftn'

           integer*4 status
           logical same_volume

           integer*4 address1, address2, dummy1, dummy2
           pointer /address1/ dummy1
           pointer /address2/ dummy2

           same_volume = ms_$neighbors(address1, address2, status)

DESCRIPTION
     This call returns a Boolean value indicating whether the objects mapped
     at address1 and address2 reside on the same volume.  If ms_$neighbors
     returns true, then both objects reside on the same volume.  If
     ms_$neighbors returns false, then the objects reside on different
     volumes.

     Ms_$neighbors is especially useful with temporary objects, which lack
     pathnames.

     address1
          A pointer to a mapped object.

     address2
          A pointer to another mapped object.

     status
          The completion status.  Ms_$neighbors returns with
          ms_$different_volumes in status if the object at address1 or
          address2 is locked by a process on another node.
Museum
