home *** CD-ROM | disk | FTP | other *** search
/ Il CD di internet / CD.iso / INTERNET / USENET / PAPERBOY / SOURCE.ZIP / PDL < prev    next >
Encoding:
Text File  |  1994-03-07  |  2.8 KB  |  113 lines
  1. /* Paperyboy support DLL
  2.    This Module reads in the SOUP message format packet as a series
  3.    of files. It then allows the application to easily access area
  4.    names, message headers and message text.
  5. */
  6.  
  7. /* VERSION routines */
  8.  
  9. /*    int MajorVersion(void)
  10.     Returns major version of DLL.
  11.     Major version indicates major changes, and is incompatible
  12.     with previous version
  13. */
  14.  
  15. /*    int MinorVersion(void)
  16.     Returns minor version of DLL.
  17.     Minor version indicates changes, but should remain compatible
  18.     with previous MinorVersions within the same MajorVersion
  19. */
  20.  
  21. /*    char * VersionDesc(void)
  22.     Gives a string showing the Copyright and module name
  23. */
  24.  
  25. /* AREAS support routines */
  26.  
  27. /*    int LoadAreas (const char * areasfname)
  28.     Loads up the SOUP packet from areasfname, which should be a
  29.     fully qualified drive/directory/filename, the latter usually
  30.     being AREAS. From the AREAS file, we can find the message areas,
  31.     which in turn we can find the subjects.
  32.  
  33.     Should be called before most other functions in this library.
  34.  
  35.     Returns 0 on success, an error number on failure (no such file
  36.     or unparseable file)
  37. */
  38.  
  39. /*  int GetNumAreas (void)
  40.     Returns the number of message areas. [1..GetNumAreas]
  41. */
  42.  
  43. /*    char * GetAreaName (int index)
  44.     Returns the name of the message area given of index
  45. */
  46.  
  47. /*     char * GetAreaEncoding (int index)
  48.     Returns a three character string corresponding to the encoding
  49.     of the specified message area. u?? and [Mm]?? should be the
  50.     most popular
  51. */
  52.  
  53. /*    char * GetAreaDesc (int index)
  54.     Returns the description of the specified message area. NULL
  55.     if no description available
  56. */
  57.  
  58.  
  59. /* MESSAGE HEADER support routines */
  60.  
  61. /*    int GetNumMsgs (int index)
  62.     Returns the number of messages in the area specified by index
  63.     index=[1..GetNumAreas], returns [1..GetNumHdrs]
  64. */
  65.  
  66. /*    int ThreadMsgs (int index)
  67.     Sorts the messages in area index, sorting by ascending
  68.     Base Subject (sans RE:), then date.
  69.     More intelligent sorting is possible
  70. */
  71.  
  72. /*    void UnThreadMsgs (int index)
  73.     Returns the messages to the order they naturally occur in
  74. */
  75.  
  76. /*    char * GetSubject(int areaindex, int msgindex)
  77.     Returns the Subject: line from the message
  78. */
  79.  
  80. /*    char * GetAuthor (int areaindex, int msgindex)
  81.     Returns the From: line from the message
  82. */
  83.  
  84. /*    char * GetDate     (int areaindex, int msgindex)
  85.     Returns    the Date: line from the message (FORMAT?)
  86. */
  87.  
  88. /*    void GetMsg (int areaindex, int msgindex)
  89.     Loads the message given by the indexes into the common
  90.     lines buffer
  91. */
  92.  
  93. /* MESSAGE line routines */
  94.  
  95. /*    int GetNumLines  (void)
  96.     Returns the number of lines waiting in the lines buffer
  97.     [1..GetNumLines]
  98. */
  99.  
  100. /*    char * GetLine (int lineno)    
  101.     Returns the line specified
  102. */
  103.  
  104. /* INFO routines */
  105.  
  106. /*    int GetInfo (void)
  107.     Loads the INFO file (if present) into the message buffer
  108.     Returns 0 if the file exists
  109. */
  110.  
  111. /* REPLY routines */
  112. /* LIST routines */
  113.