home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / xwphescr.zip / XWPH0208.ZIP / include / helpers / tmsgfile.h < prev    next >
C/C++ Source or Header  |  2002-07-22  |  2KB  |  67 lines
  1.  
  2. /*
  3.  *@@sourcefile tmsgfile.h:
  4.  *      header file for tmsgfile.c. See notes there.
  5.  *
  6.  *      This file is entirely new with V0.9.0.
  7.  *
  8.  *      Note: Version numbering in this file relates to XWorkplace version
  9.  *            numbering.
  10.  *
  11.  *@@include #include <os2.h>
  12.  *@@include #include "helpers\tree.h"
  13.  *@@include #include "helpers\xstring.h"
  14.  *@@include #include "helpers\tmsgfile.h"
  15.  */
  16.  
  17. #if __cplusplus
  18. extern "C" {
  19. #endif
  20.  
  21. #ifndef TMSGFILE_HEADER_INCLUDED
  22.     #define TMSGFILE_HEADER_INCLUDED
  23.  
  24.     #ifndef XSTRING_HEADER_INCLUDED
  25.         #error tmsgfile.h requires xstring.h to be included first.
  26.     #endif
  27.  
  28.     #ifndef XWPTREE_INCLUDED
  29.         #error tmsgfile.h requires tree.h to be included first.
  30.     #endif
  31.  
  32.     /*
  33.      *@@ TMFMSGFILE:
  34.      *      representation of a text message file opened by
  35.      *      tmfOpenMessageFile.
  36.      *
  37.      *@@added V0.9.16 (2001-10-08) [umoeller]
  38.      */
  39.  
  40.     typedef struct _TMFMSGFILE
  41.     {
  42.         PSZ     pszFilename;            // copy of .TMF file name
  43.  
  44.         TREE    *IDsTreeRoot;           // root of tree with MSGENTRY's (a TREE* really)
  45.         ULONG   cIDs;                   // count of entries in the tree
  46.  
  47.         CHAR    szTimestamp[30];
  48.     } TMFMSGFILE, *PTMFMSGFILE;
  49.  
  50.     APIRET tmfOpenMessageFile(const char *pcszMessageFile,
  51.                               PTMFMSGFILE *ppMsgFile);
  52.  
  53.     APIRET tmfCloseMessageFile(PTMFMSGFILE *ppMsgFile);
  54.  
  55.     APIRET tmfGetMessage(PTMFMSGFILE pMsgFile,
  56.                          PCSZ pcszMessageName,
  57.                          PXSTRING pstr,
  58.                          PCSZ *pTable,
  59.                          ULONG cTableEntries);
  60.  
  61. #endif // TMSGFILE_HEADER_INCLUDED
  62.  
  63. #if __cplusplus
  64. }
  65. #endif
  66.  
  67.