filelist.h

#ifndef __FILELIST_H__
#define __FILELIST_H__
/*=============================================================================   
     Module  : filelist.h
     Purpose : Define a structure for obtaining and storing a list of file
               names.
     Author  : Doug Ehlenberger, CNIC Mt. Sinai School of Medicine
               
   
==============================================================================*/
#include "configure.h"
#include "dllist.h"


/* See dllist.h for macro definition. */

DefineDll
   (
   FileList             ,
   vSTRING  fileName;
   vINT     fileNumber; ,
   vINT     pad;
   );


typedef enum
   {
   vFILE_LIST_NO_ERROR,
   vFILE_LIST_ERROR_NO_FILES,
   vFILE_LIST_ERROR_INVALID_SPEC,
   vFILE_LIST_ERROR_OUT_OF_MEMORY
   }
   vFILE_LIST_ERROR_CODE;


vFILE_LIST_ERROR_CODE InitFileList( FileList *fileList );


/* GetFileList()

   Working directory must be set before calling. 

   Given a "sample" file name, obtain a list of file names with
   the same prefix and extension. The list is ordered by the number
   part of the file name.

   Assumed file name spec: 

    < > = required
    [ ] = optional

    [ prefix ]< number >[ '.' ][ extension ]
                                  
   The number should indicate the ordering of the files with a lower
   number indicating that the file "comes before" another file.
*/

vFILE_LIST_ERROR_CODE GetFileList( FileList *fileList, vSTRING sampleFileName );


/* Given a file name, parse out the prefix and extension. */

vVOID SplitFileListName( vSTRING fileName, vSTRING prefix, vSTRING extension );


/* Given a file name and length of the prefix, parse out the file number. */

vBOOL ParseFileListNumber( vSTRING fileName, vSIZE prefixLength, vINT *fileNumber );


vSIZE SizeOfFileList( FileList *fileList );

FileListIterator BeginFileList( FileList *fileList );
FileListIterator EndFileList( FileList *fileList );

FileListIterator NextFileListIterator( FileListIterator iter );


vVOID DestroyFileList( FileList *fileList );


#endif/* __FILELIST_H__ */

---