diplodocus.org Git - nmh/blob - sbr/seq_read.h

   1 /* seq_read.h -- read the .mh_sequence file and
   2  *            -- initialize sequence information
   3  *
   4  * This code is Copyright (c) 2017, by the authors of nmh.  See the
   5  * COPYRIGHT file in the root directory of the nmh distribution for
   6  * complete copyright information. */
   7
   8 /*
   9  * Read the sequence files for the folder referenced in the given
  10  * struct msgs and populate the sequence entries in the struct msgs.
  11  *
  12  * Arguments:
  13  *
  14  * mp           - Folder structure to add sequence entries to
  15  * lockflag     - If true, obtain a write lock on the sequence file.
  16  *                Additionally, the sequence file will remain open
  17  *                and a pointer to the filehandle will be stored in
  18  *                folder structure, where it will later be used by
  19  *                seq_save().
  20  *
  21  * Return values:
  22  *     OK       - successfully read the sequence files, or they don't exist
  23  *     NOTOK    - failed to lock sequence file
  24  */
  25 int seq_read(struct msgs *, int);