home *** CD-ROM | disk | FTP | other *** search
/ World of Shareware - Software Farm 2 / wosw_2.zip / wosw_2 / CPROG / CBASE101.ZIP / BLKIO112.ZIP / BGETH.C < prev    next >
Text File  |  1990-06-20  |  1KB  |  50 lines
  1. /*    Copyright (c) 1989 Citadel    */
  2. /*       All Rights Reserved        */
  3.  
  4. /* #ident    "@(#)bgeth.c    1.4 - 90/06/20" */
  5.  
  6. /* ansi headers */
  7. /*#include <stddef.h>*/
  8.  
  9. /* local headers */
  10. #include "blkio_.h"
  11.  
  12. /*man---------------------------------------------------------------------------
  13. NAME
  14.      bgeth - get the header from a block file
  15.  
  16. SYNOPSIS
  17.      #include <blkio.h>
  18.  
  19.      int bgeth(bp, buf)
  20.      BLKFILE *bp;
  21.      void *buf;
  22.  
  23. DESCRIPTION
  24.      The bgeth function reads the header from the block file
  25.      associated with BLKFILE pointer bp.  buf must point to a storage
  26.      area at least as large as the header size for bp.
  27.  
  28.      bgeth will fail if one or more of the following is true:
  29.  
  30.      [EINVAL]       bp is not a valid block file.
  31.      [EINVAL]       buf is NULL.
  32.      [BEEOF]        bp is empty.
  33.      [BEEOF]        End of file encountered within header.
  34.      [BENOPEN]      bp is not open for reading.
  35.  
  36. SEE ALSO
  37.      bgetb, bgethf, bputh.
  38.  
  39. DIAGNOSTICS
  40.      Upon successful completion, a value of 0 is returned.  Otherwise,
  41.      a value of -1 is returned, and errno set to indicate the error.
  42.  
  43. ------------------------------------------------------------------------------*/
  44. int bgeth(bp, buf)
  45. BLKFILE *bp;
  46. void *buf;
  47. {
  48.     return bgethf(bp, (size_t)0, buf, bp->hdrsize);
  49. }
  50.