Click above to get retro games delivered to your door ever month!

 VolBlockPurgeGet()
------------------------------------------------------------------------------
 Purpose:
 Get the number of purgeable blocks on a volume.

 Syntax:
 dwBlocks = VolBlockPurgeGet( iVolNum )

 Parameters:
 iVolNum The volume number - 0 for the first volume, 1 for the second etc.

 Returns:
 A numeric value (unsigned long int).

 The CA-Clipper name for this function is:
 VolBlkPurGet()

 Description:
 VolBlockPurgeGet() returns the number of purgable blocks on volume number
 iVolNum. Purgable blocks are disks blocks that are occupied by deleted
 files.

 Returns NOVERRLONG if an error occurs.

 Example:
 // To display the number of purgeable blocks on the first disk volume:
 dwAvail = VolBlockPurgeGet(0)
 if ( dwAvail != NOVERRLONG )
    ? "There are", dwAvail, "blocks occupied by deleted files "
    ??"on volume 0"
 endif
 // To display the number of free blocks on the first disk volume
 // including blocks that would be made available by purging the volume,
 // (similar to the result returned by Novell's VOLINFO.EXE).
 dwAvail = ( VolBlockFreeGet(0) * VolBlockSizeGet(0) )
          + ( VolBlockPurgeGet(0) * VolBlockSizeGet(0) )
 if ( dwAvail != NOVERRLONG )
    ?  "There are ", dwAvail, " possible free blocks on volume 0"
 endif

 Notes:
 The block size may be found by calling VolBlockSizeGet().

 IMPORTANT: The value returned by VolBlockSizeGet() does NOT include space
 occupied by files waiting to be purged. Novell's VOLINFO.EXE command line
 utility calculates the free space of a volume as the sum of the actual free
 space and the space that would be made available by purging deleted files.
 This can be achieved with NOVLIB by adding the result of VolBlockFreeGet()
 to the result of VolBlockPurgeGet().