home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / MISC / PBAPI10.ZIP / APIDOCS.ZIP / MNNNNTXT.DOC < prev    next >
Text File  |  1998-02-21  |  2KB  |  49 lines
  1. Author....... : Gary Price
  2. Copyrighted by: Freejack's Software 1997-98
  3.  
  4. MNNNN_TXT API for TriBBS v10.x/11.x written in PowerBasic v3.5
  5. ---------------------------------------------------------------------------
  6.  
  7. The MNNNN_TXT unit is used to manipulate data in the MNNNN.TXT data file
  8. found in node 1's MWORK directory. The MNNNN_TXT unit is declared in
  9. PBAPI10.INC as follows:
  10.  
  11. FUNCTION's below are from the MNNNNT.PBU Unit and DECLAREd in PBAPI10.INC.
  12.  
  13. FUNCTION MNNNN_TXT_OPEN(c AS INTEGER)
  14. FUNCTION MNNNN_TXT_READ() AS STRING
  15. FUNCTION MNNNN_TXT_CLOSE()
  16.  
  17. ---------------------------------------------------------------------------
  18.  ** EXTERNAL FUNCTION USED BY MNNNN.TXT UNIT BELOW **
  19.  
  20. FUNCTION MNNNN_HDR_GetOITF() AS LONG
  21. FUNCTION MNNNN_HDR_GetML() AS LONG
  22.  
  23. ---------------------------------------------------------------------------
  24.  Starting with TriBBS 10.0, the Mnnnn.txt files no longer use compression.
  25.  Each message is save as one large null-terminated C - string, in PowerBasic
  26.  this would be CHR$(0). Furthermore, each line in the message is terminated
  27.  by a carriage return '\r', in PowerBasic this would be CHR$(13).
  28. ---------------------------------------------------------------------------
  29.  
  30.  MPORTANT: TBNode1sMainDirectory must be set to node 1's main directory
  31.  before calling this function.
  32.  
  33. MNNNN_TXT_OPEN(c AS INTEGER)
  34.  The MNNNN_TXT_OPEN function opens the Mnnnn.txt data file, where nnnn is
  35.  specified by "c", in node 1's MWORK directory.
  36.  
  37. MNNNN_TXT_READ() AS STRING
  38.  This form of the MNNNN_TXT_READ function returns a pointer to the message's
  39.  text as one long string for the current open record.
  40.  
  41. MNNNN_TXT_CLOSE() 
  42.  The MNNNN_TXT_Close function closes the Mnnnn.txt data file in node 1's
  43.  MWORK directory.
  44.  
  45. ---------------------------------------------------------------------------
  46. This is all for this Unit for now, I plan on falling back to this Unit and
  47. adding more Functions as I progress with other Units in this API.
  48.  
  49.