home *** CD-ROM | disk | FTP | other *** search
/ Amiga ISO Collection / AmigaUtilCD1.iso / Fax / AVMA&GPFax-V1,33Sources.LHA / simplerexx.h < prev    next >
Encoding:
C/C++ Source or Header  |  1994-05-25  |  3.2 KB  |  118 lines
  1. /* $Header: pd:zvmRCS/simplerexx.h,v 1.2 1993/04/19 18:40:06 rvillari Exp rvillari $ */
  2. /*
  3.  * Simple ARexx interface by Michael Sinz
  4.  *
  5.  * This is a very "Simple" interface...
  6.  */
  7.  
  8. #ifndef    SIMPLE_REXX_H
  9. #define    SIMPLE_REXX_H
  10.  
  11. #include    <exec/types.h>
  12. #include    <exec/nodes.h>
  13. #include    <exec/lists.h>
  14. #include    <exec/ports.h>
  15.  
  16. #include    <rexx/storage.h>
  17. #include    <rexx/rxslib.h>
  18.  
  19. /*
  20.  * This is the handle that SimpleRexx will give you
  21.  * when you initialize an ARexx port...
  22.  *
  23.  * The conditional below is used to skip this if we have
  24.  * defined it earlier...
  25.  */
  26. #ifndef    AREXXCONTEXT
  27.  
  28. typedef void *AREXXCONTEXT;
  29.  
  30. #endif    /* AREXXCONTEXT */
  31.  
  32. /*
  33.  * The value of RexxMsg (from GetARexxMsg) if there was an error returned
  34.  */
  35. #define    REXX_RETURN_ERROR    ((struct RexxMsg *)-1L)
  36.  
  37. /*
  38.  * This function closes down the ARexx context that was opened
  39.  * with InitARexx...
  40.  */
  41. void FreeARexx(AREXXCONTEXT);
  42.  
  43. /*
  44.  * This routine initializes an ARexx port for your process
  45.  * This should only be done once per process.  You must call it
  46.  * with a valid application name and you must use the handle it
  47.  * returns in all other calls...
  48.  *
  49.  * NOTE:  The AppName should not have spaces in it...
  50.  *        Example AppNames:  "MyWord" or "FastCalc" etc...
  51.  *        The name *MUST* be less that 16 characters...
  52.  *        If it is not, it will be trimmed...
  53.  *        The name will also be UPPER-CASED...
  54.  *
  55.  * NOTE:  The Default file name extension, if NULL will be
  56.  *        "rexx"  (the "." is automatic)
  57.  */
  58. AREXXCONTEXT InitARexx(char *,char *);
  59. AREXXCONTEXT InitARexxSingleApp(char*, char*);
  60. int OutstandingMsg(AREXXCONTEXT);
  61.  
  62. /*
  63.  * This function returns the port name of your ARexx port.
  64.  * It will return NULL if there is no ARexx port...
  65.  *
  66.  * This string is *READ ONLY*  You *MUST NOT* modify it...
  67.  */
  68. char *ARexxName(AREXXCONTEXT);
  69.  
  70. /*
  71.  * This function returns the signal mask that the Rexx port is
  72.  * using.  It returns NULL if there is no signal...
  73.  *
  74.  * Use this signal bit in your Wait() loop...
  75.  */
  76. ULONG ARexxSignal(AREXXCONTEXT);
  77.  
  78. /*
  79.  * This function returns a structure that contains the commands sent from
  80.  * ARexx...  You will need to parse it and return the structure back
  81.  * so that the memory can be freed...
  82.  *
  83.  * This returns NULL if there was no message...
  84.  */
  85. struct RexxMsg *GetARexxMsg(AREXXCONTEXT);
  86. void* GetReplyARexxMsg(AREXXCONTEXT);
  87.  
  88. /*
  89.  * Use this to return a ARexx message...
  90.  *
  91.  * If you wish to return something, it must be in the RString.
  92.  * If you wish to return an Error, it must be in the Error.
  93.  */
  94. void ReplyARexxMsg(AREXXCONTEXT,struct RexxMsg *,char *,LONG);
  95.  
  96. /*
  97.  * This function will send a string to ARexx...
  98.  *
  99.  * The default host port will be that of your task...
  100.  *
  101.  * If you set StringFile to TRUE, it will set that bit for the message...
  102.  *
  103.  * Returns TRUE if it send the message, FALSE if it did not...
  104.  */
  105. void* SendARexxMsg(AREXXCONTEXT,char *,short);
  106.  
  107. /*
  108.  * This function will set an error string for the ARexx
  109.  * application in the variable defined as <appname>.LASTERROR
  110.  *
  111.  * Note that this can only happen if there is an ARexx message...
  112.  *
  113.  * This returns TRUE if it worked, FALSE if it did not...
  114.  */
  115. short SetARexxLastError(AREXXCONTEXT,struct RexxMsg *,char *);
  116.  
  117. #endif    /* SIMPLE_REXX_H */
  118.