home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / prgramer / rexx / rxmsgapi / rxmsgapi.inf (.txt) < prev    next >
Encoding:
OS/2 Help File  |  1993-03-29  |  17.1 KB  |  635 lines
  1.  
  2. ΓòÉΓòÉΓòÉ 1. LICENSE terms ΓòÉΓòÉΓòÉ
  3.  
  4. SRI is copyright (Γòò) Colin Adams 1992,1993. 
  5.  
  6. SRI (Squish/Rexx Interface) may be used freely in a non-commercial envrionment. 
  7. If SRI is to be used in a commercial environment then a cheque for 10 pounds 
  8. sterling drawn on a UK bank (or 15 pounds sterling if via International Money 
  9. order, or the like) should be sent to: 
  10.  
  11.  Colin Adams
  12.  14 Colman Court
  13.  Preston
  14.  Lancashire
  15.  PR1 8DL
  16.  United Kingdom
  17.  
  18.  
  19. ΓòÉΓòÉΓòÉ 2. Introduction ΓòÉΓòÉΓòÉ
  20.  
  21. RXMSGAPI is a Rexx DLL to allow Rexx programmers to call functions within Scott 
  22. Dudley's MSGAPI.DLL. This enables the Rexx programmer to write applications to 
  23. manipulate FidoNet-style Squish and *.MSG message bases. 
  24.  
  25. Scott Dudley's MSGAPI.DOC document is essential supplemental reading. 
  26.  
  27.  
  28. ΓòÉΓòÉΓòÉ 3. Using the MSGAPI interface ΓòÉΓòÉΓòÉ
  29.  
  30.  1. Installation 
  31.  
  32.  2. Writing a Rexx exec that uses MSGAPI 
  33.  
  34.  
  35. ΓòÉΓòÉΓòÉ 3.1. Installation ΓòÉΓòÉΓòÉ
  36.  
  37.  1. Copy RXMSGAPI.DLL to a directory specified in your LIBPATH statement, in 
  38.     CONFIG.SYS . Do not rename the .DLL file. 
  39.  
  40.  2. Reboot OS/2. 
  41.  
  42.  3. Inspect the supplied test.cmd Rexx exec - suitably edited, also test2.cmd. 
  43.  
  44.  4. Write your own very first Rexx MSGAPI program. 
  45.  
  46.  
  47. ΓòÉΓòÉΓòÉ 3.2. Writing a Rexx exec that uses MSGAPI ΓòÉΓòÉΓòÉ
  48.  
  49.  1. Allocating the DLL 
  50.  
  51.  2. Freeing the DLL 
  52.  
  53.  
  54. ΓòÉΓòÉΓòÉ 3.2.1. Allocating the DLL ΓòÉΓòÉΓòÉ
  55.  
  56. In order to activate the MSGAPI interface, you must first make the DLL 
  57. available to your Rexx exec. As IBM do not document this very well (HELP 
  58. REX0115 will give you a clue), I will give complete instructions: 
  59.  
  60.  1. Register the DLL and name the command environment 
  61.  
  62.     The RXSUBCOM command must be used to perform this operation. All following 
  63.     examples assume a default environment of CMD (the OS/2 command processor). 
  64.  
  65.         /* Rexx exec using MSGAPI */
  66.         'RXSUBCOM Register MSGAPI RXMSGAPI RXMSGAPI'
  67.  
  68.     The first parameter to the Register function of RXSUBCOM, names the command 
  69.     environment you wish to use on the address command. In this case MSGAPI. 
  70.     You can change this to whatever you wish, but it is not recommended. 
  71.  
  72.  2. Load the DLL. 
  73.  
  74.         'RXSUBCOM Load MSGAPI RXMSGAPI'
  75.  
  76.  3. Commands can now be sent to the MSGAPI interface using address MSGAPI (or 
  77.     whatever you named it). 
  78.  
  79.  
  80. ΓòÉΓòÉΓòÉ 3.2.2. Freeing the DLL ΓòÉΓòÉΓòÉ
  81.  
  82. When you have finished using the interface, you can save storage by freeing it 
  83. up: 
  84.  
  85. address CMD 'rxsubcom drop msgapi'
  86.  
  87.  
  88. ΓòÉΓòÉΓòÉ 4. Reference ΓòÉΓòÉΓòÉ
  89.  
  90. Note:  All RXMSGAPI command names are case sensitive. For parameters that will 
  91. be passed to MSGAPI, consult MSGAPI.DOC . In particular, Rexx NAMES passed to 
  92. an API must be in UPPER CASE. 
  93.  
  94.  
  95. ΓòÉΓòÉΓòÉ 4.1. Return codes ΓòÉΓòÉΓòÉ
  96.  
  97. RXMSGAPI raises the FAILURE condition if an unknown command request is passed 
  98. to it - this represents a Rexx programmer error, and should be trapped during 
  99. development of your Rexx code. 
  100.  
  101. In all other error cases, RXMSGAPI raises the ERROR condition. It is a question 
  102. of programming style wether or not to trap this condition. 
  103.  
  104.  1. Parameter validation errors 
  105.  
  106.  2. Rexx Shared Variables interface return codes 
  107.  
  108.  3. API return codes 
  109.  
  110.  
  111. ΓòÉΓòÉΓòÉ 4.1.1. Parameter validation errors ΓòÉΓòÉΓòÉ
  112.  
  113. If the DLL detects a problem with the parameters passed to it (only rudimentary 
  114. checking is done - e.g. are the right number passed) it returns one of the 
  115. following codes in RC: 
  116.  
  117. -9991 
  118.           Error with first parameter 
  119.  
  120. -9992 
  121.           Error with second parameter 
  122.  
  123. -9993 
  124.           Error with third parameter 
  125.  
  126. -9994 
  127.           Error with fourth parameter 
  128. etc. 
  129.  
  130. If there is an error from the Rexx Shared Variables interface, then RXMSGAPI 
  131. returns -8880 minus the error code from the interface - (you have probably 
  132. specified the wrong variable name). 
  133.  
  134.  
  135. ΓòÉΓòÉΓòÉ 4.1.2. Rexx Shared Variables interace return codes ΓòÉΓòÉΓòÉ
  136.  
  137. RXSHV_OK   - 0 
  138.           The request was processed with out error (all flag bits are FALSE). 
  139.  
  140. RXSHV_NEWV  - 1 
  141.           The named variable was uninitialized. 
  142.  
  143. RXSHV_LVAR  - 2 
  144.           No more variables are available for an RXSHV_NEXTV operation. 
  145.  
  146. RXSHV_TRUNC - 4 
  147.           A variable value or variable name was truncated because the supplied 
  148.           RXSTRING was too small for the copied value. 
  149.  
  150. RXSHV_BADN  - 8 
  151.           The variable name specified in shvname was invalid for the requested 
  152.           operation. 
  153.  
  154. RXSHV_MEMFL - 16 
  155.           The REXX interpreter was unable to obtain the storage required to 
  156.           complete the request. 
  157.  
  158. RXSHV_BADF  - 128 
  159.           The shared variable request block contains an invalid function code. 
  160.  
  161.  
  162. ΓòÉΓòÉΓòÉ 4.1.3. API return codes ΓòÉΓòÉΓòÉ
  163.  
  164. If the API returns error-free, then RC is set to 0. 
  165.  
  166. Otherwise RC is set to a string of the form: 
  167.  
  168.  APIname returned error code number 
  169.  
  170.  
  171. ΓòÉΓòÉΓòÉ 4.2. OPEN_API ΓòÉΓòÉΓòÉ
  172.  
  173. address MSGAPI 'OPEN_API [default_zone [revision_level]]'
  174.  
  175. where: 
  176.  
  177. o revision_level requests which version of the MSG API you wish to request - 
  178.   omit for the default - 0. 
  179.  
  180.   Note:  Anything other than 0 may cause a general protection fault - it does 
  181.   here! 
  182.  
  183. o default_zone indicates a default fidonet zone - defaults to 2 if omitted 
  184.  
  185.  
  186. ΓòÉΓòÉΓòÉ 4.3. CLOSE_API ΓòÉΓòÉΓòÉ
  187.  
  188. address MSGAPI 'CLOSE_API'
  189.  
  190.  
  191. ΓòÉΓòÉΓòÉ 4.4. OPEN_AREA ΓòÉΓòÉΓòÉ
  192.  
  193. address MSGAPI 'OPEN_AREA' 'msg_area' 'msg_area_name' 'mode' 'type'
  194.  
  195. where: 
  196.  
  197. o msg_area is the NAME of a Rexx variable that will be set by OPEN_AREA. You 
  198.   then pass this name to the other MSGAPI calls (actually you can pass any 
  199.   variable name to the other MSGAPI calls, as long as the VALUE of the variable 
  200.   contains the value set by OPEN_AREA). 
  201.  
  202. o 
  203.  
  204.   msg_area_name is the name of a squish or *.msg area. This name should be a 
  205.   *.MSG directory name or a squish base name, as per squish.cfg. It is NOT the 
  206.   TAG name. 
  207.  
  208. o mode is the access mode for the area. Possible values are: 
  209.  
  210.    MSGAREA_NORMAL open fails if the area does not exist 
  211.    MSGAREA_CRIFNEC open will attempt to create the area if it does not exist. 
  212.                   Open will fail if it is unable to create the area. 
  213.    MSGAREA_CREATE open will attempt to create the area or truncate it to no 
  214.                   messages. 
  215.  
  216. o type is the type of message area. Possible values are: 
  217.  
  218.    SQUISH Squish format area 
  219.    SDM    *.MSG format area 
  220.    SDMECHO *.MSG format echomail area (1.MSG contains a highwatermark) 
  221.  
  222.  
  223. ΓòÉΓòÉΓòÉ 4.5. CLOSE_AREA ΓòÉΓòÉΓòÉ
  224.  
  225. address MSGAPI 'CLOSE_AREA' 'msg_area'
  226.  
  227. where: 
  228.  
  229. msg_area is the NAME of a Rexx variable. This variable should contain the value 
  230. set by an OPEN_AREA call. 
  231.  
  232.  
  233. ΓòÉΓòÉΓòÉ 4.6. OPEN_MSG ΓòÉΓòÉΓòÉ
  234.  
  235. address MSGAPI 'OPEN_MSG' 'msg_handle' 'msg_area' 'mode' 'message_number'
  236.  
  237. where: 
  238.  
  239. o msg_handle is the NAME of a Rexx variable. OPEN_MSG will set this and its 
  240.   value should be passed to other API functions. 
  241.  
  242. o msg_area is the NAME of a Rexx variable. This should contain a value obtained 
  243.   from OPEN_AREA. 
  244.  
  245. o mode is the access mode for the area. Possible values are: 
  246.  
  247.    MOPEN_CREATE create a NEW message. 
  248.    MOPEN_READ  open an existing message for READ ONLY. 
  249.    MOPEN_WRITE open an existing message for WRITE ONLY. 
  250.    MOPEN_RW    open an existing message for both reading and writing. 
  251.  
  252. o message_number is the number of the message. See MSGAPI.DOC for the meaning. 
  253.   For MOPEN_READ or MOPEN_RW you can also specify: 
  254.  
  255.    MSGNUM_CUR The current message 
  256.    MSGNUM_NEXT The next message 
  257.    MSGNUM_PREV The previous message. as per MSGAPI.DOC . 
  258.  
  259.  
  260. ΓòÉΓòÉΓòÉ 4.7. CLOSE_MSG ΓòÉΓòÉΓòÉ
  261.  
  262. address MSGAPI 'CLOSE_MSG' 'msg_var'
  263.  
  264. where: 
  265.  
  266. msg_var is the NAME of a Rexx variable. This variable should contain the value 
  267. set by an OPEN_MSG call. 
  268.  
  269.  
  270. ΓòÉΓòÉΓòÉ 4.8. READ_MSG ΓòÉΓòÉΓòÉ
  271.  
  272. address MSGAPI 'READ_MSG' 'msg_handle' 'xmsg_stem' 'offset' 'bytes' 'text_var' 'control_bytes' 'control_var'
  273.  
  274. Where: 
  275.  
  276. o msg_handle is the NAME of a Rexx variable. This variable should contain the 
  277.   value set be an OPEN_MSG call. 
  278.  
  279. o xmsg_stem is the NAME of a Rexx stem variable. The name MUST contain a 
  280.   terminating period, or the name MUST be the literal: NULL. If the name is 
  281.   NULL then no message header information will be returned. Otherwise READ_MSG 
  282.   will set the following variables: (assume an xmsg_stem value of XMSG.) 
  283.  
  284.    - XMSG.attr 
  285.  
  286.    - XMSG.from 
  287.  
  288.    - XMSG.to 
  289.  
  290.    - XMSG.subj 
  291.  
  292.    - XMSG.orig 
  293.  
  294.    - XMSG.dest 
  295.  
  296.    - XMSG.date_written 
  297.  
  298.    - XMSG.date_arrived 
  299.  
  300.    - XMSG.utc_ofs 
  301.  
  302.    - XMSG.replyto 
  303.  
  304.    - XMSG.replies.[1..10] 
  305.  
  306.    - XMSG.ftsc_date 
  307.  
  308.   See MSGAPI header files for the meaning/values of these fields. 
  309.  
  310. o offset should be a decimal number specifying an offset into the body of the 
  311.   message at which to start reading text. Specify 0 for the begining of the 
  312.   message body. 
  313.  
  314. o bytes specifies the maximum number of bytes to read from the message body. 
  315.   Specify 0 if you do not wish to read the message text. 
  316.  
  317. o text_var should be the NAME of a Rexx variable to hold the read message text. 
  318.   Specify the literal name NULL if you do not wish to read the message body. 
  319.  
  320. o control_bytes specifies the maximum number of bytes of control information to 
  321.   be read. Specify 0 if you do not wish to read the control information. 
  322.  
  323. o control_var should be the NAME of a Rexx variable to hold the control 
  324.   information read. Specify the literal NULL if you do not wish to read the 
  325.   control information. 
  326.  
  327. RC is set to the number of bytes transferred. 
  328.  
  329.  
  330. ΓòÉΓòÉΓòÉ 4.9. WRITE_MSG ΓòÉΓòÉΓòÉ
  331.  
  332. address MSGAPI 'WRITE_MSG' 'msg_handle' 'append' 'xmsg_stem' 'text' 'textlen' 'totlen' 'control_len' 'control_var'
  333.  
  334. Where: 
  335.  
  336. o msg_handle is the NAME of a Rexx variable. This variable should contain the 
  337.   value set be an OPEN_MSG call. 
  338.  
  339. o append 
  340.  
  341.   Set to 1 to append message text. Otherwise set to 0. 
  342.  
  343. o xmsg_stem is the NAME of a Rexx stem variable. The name MUST contain a 
  344.   terminating period, or the name MUST be the literal: NULL. If the name is 
  345.   NULL then no message header information will be set. Otherwise WRITE_MSG will 
  346.   set the message header from the following variables: (assume an xmsg_stem 
  347.   value of XMSG.) 
  348.  
  349.    - XMSG.attr 
  350.  
  351.      This must be numeric. 
  352.  
  353.    - XMSG.from 
  354.  
  355.      This should be the name of the user from whom the message is coming. 
  356.  
  357.    - XMSG.to 
  358.  
  359.      This should be the name of the user to whom the message is going. 
  360.  
  361.    - XMSG.subj 
  362.  
  363.      This should be the subject of the message. 
  364.  
  365.    - XMSG.orig 
  366.  
  367.      This should be the originating address of the message in the form: 
  368.  
  369.           zone:net/node.point
  370.  
  371.      ALL components should be specified. @fidonet.org must NOT be added. 
  372.  
  373.    - XMSG.dest 
  374.  
  375.      This should be the destination address. Form as per Originating Address. 
  376.  
  377.    - XMSG.date_written 
  378.  
  379.      This should be the date and time when the message is written in UTC. The 
  380.      form MUST be: 
  381.  
  382.           dd/mm/yyyy:hh:mm:ss
  383.  
  384.    - XMSG.date_arrived 
  385.  
  386.      This should be the date the message has arrived. Set it to the date the 
  387.      message is written. 
  388.  
  389.    - XMSG.utc_ofs 
  390.  
  391.      The number of minutes past UTC in your local area. 
  392.  
  393.    - XMSG.replyto 
  394.  
  395.      The Unique Message-id of a message to which this is a reply. 
  396.  
  397.    - XMSG.replies.[1..10] 
  398.  
  399.      Stems .1 through .10 must be set to the Unique message-ids which are 
  400.      replies to this message. Therefore set all to 0. 
  401.  
  402.    - XMSG.ftsc_date 
  403.  
  404.      Set this string to the FTSC date and time of the message. 
  405.  
  406. o text is the NAME of a Rexx variable. This variable should contain the text of 
  407.   the message. Specify the literal NULL if no message text is to be written. 
  408.  
  409. o textlen is the length of the text of the message. Set to 0 if no message text 
  410.   is to be written. 
  411.  
  412. o totlen is the TOTAL length of the text of the message. Of special use for 
  413.   writing multi-pass messages. Set to 0 if no message text is to be written. 
  414.  
  415. o control_len is the length of the control information. Set to 0 if no control 
  416.   information is to be written. 
  417.  
  418. o control_var is the NAME of a Rexx variable. This variable should contain the 
  419.   control information for the message. Specify the literal NULL if no control 
  420.   information is to be written. 
  421.  
  422.  
  423. ΓòÉΓòÉΓòÉ 4.10. KILL_MSG ΓòÉΓòÉΓòÉ
  424.  
  425. address MSGAPI 'KILL_MSG' 'msg_area' 'message_number'
  426.  
  427. Where: 
  428.  
  429. o msg_area is the NAME of a Rexx variable. This should contain a value obtained 
  430.   from OPEN_AREA. 
  431.  
  432. o message_number is the number of the message to kill. 
  433.  
  434.  
  435. ΓòÉΓòÉΓòÉ 4.11. LOCK ΓòÉΓòÉΓòÉ
  436.  
  437. address MSGAPI 'LOCK' 'msg_area'
  438.  
  439. Where: 
  440.  
  441. o msg_area is the NAME of a Rexx variable. This should contain a value obtained 
  442.   from OPEN_AREA. 
  443.  
  444.  
  445. ΓòÉΓòÉΓòÉ 4.12. UNLOCK ΓòÉΓòÉΓòÉ
  446.  
  447. address MSGAPI 'UNLOCK' 'msg_area'
  448.  
  449. Where: 
  450.  
  451. o msg_area is the NAME of a Rexx variable. This should contain a value obtained 
  452.   from OPEN_AREA. 
  453.  
  454.  
  455. ΓòÉΓòÉΓòÉ 4.13. GET_CURRENT_POSITION ΓòÉΓòÉΓòÉ
  456.  
  457. address MSGAPI 'GET_CURRENT_POSITION' 'message_handle' 'position'
  458.  
  459. Where: 
  460.  
  461. o message_handle is the NAME of a Rexx variable. This should contain a value 
  462.   obtained from OPEN_MSG. 
  463.  
  464. o position is the NAME of a Rexx variable. This will be set to the current 
  465.   position within the body of the message, if RC is set to zero. 
  466.  
  467.  
  468. ΓòÉΓòÉΓòÉ 4.14. MSGN_TO_UID ΓòÉΓòÉΓòÉ
  469.  
  470. address MSGAPI 'MSGN_TO_UID' 'msg_area' 'msgnum'
  471.  
  472. Where: 
  473.  
  474. o msg_area is the NAME of a Rexx variable. This should contain a value obtained 
  475.   from OPEN_AREA. 
  476.  
  477. o msgnum is the NAME of a Rexx variable. This should contain the message number 
  478.   to be converted. If RC is set to zero, then conversion is successful. 
  479.  
  480.  
  481. ΓòÉΓòÉΓòÉ 4.15. UID_TO_MSGN ΓòÉΓòÉΓòÉ
  482.  
  483. address MSGAPI 'UID_TO_MSGN' 'msg_area' 'msgnum' 'type'
  484.  
  485. Where: 
  486.  
  487. o msg_area is the NAME of a Rexx variable. This should contain a value obtained 
  488.   from OPEN_AREA. 
  489.  
  490. o msgnum is the NAME of a Rexx variable. This should contain the message number 
  491.   to be converted. If RC is set to zero, then conversion is successful. 
  492.  
  493. o type is an ASCII literal specifying the type of conversion to be performed: 
  494.  
  495.    EXACT     Returns the message number if it exists, or 0. 
  496.  
  497.    PREV      Returns the message number if it exists, or the previous message. 
  498.  
  499.    NEXT      Returns the message number if it exists, or the next message. 
  500.  
  501.  
  502. ΓòÉΓòÉΓòÉ 4.16. GET_HIGH_WATER ΓòÉΓòÉΓòÉ
  503.  
  504. address MSGAPI 'GET_HIGH_WATER' 'msg_area' 'mark'
  505.  
  506. Where: 
  507.  
  508. o msg_area is the NAME of a Rexx variable. This should contain a value obtained 
  509.   from OPEN_AREA. 
  510.  
  511. o mark is the NAME of a Rexx variable. This will be set to the high-water-mark 
  512.   if RC is zero. 
  513.  
  514.  
  515. ΓòÉΓòÉΓòÉ 4.17. SET_HIGH_WATER ΓòÉΓòÉΓòÉ
  516.  
  517. address MSGAPI 'SET_HIGH_WATER' 'msg_area' 'mark'
  518.  
  519. Where: 
  520.  
  521. o msg_area is the NAME of a Rexx variable. This should contain a value obtained 
  522.   from OPEN_AREA. 
  523.  
  524. o mark is the NAME of a Rexx variable. This should contain the high-water-mark 
  525.   to be set. 
  526.  
  527.  
  528. ΓòÉΓòÉΓòÉ 4.18. GET_TEXT_LENGTH ΓòÉΓòÉΓòÉ
  529.  
  530. address MSGAPI 'GET_TEXT_LENGTH' 'message_handle' 'length'
  531.  
  532. Where: 
  533.  
  534. o message_handle is the NAME of a Rexx variable. This should contain a value 
  535.   obtained from OPEN_MSG. 
  536.  
  537. o length is the NAME of a Rexx variable. This will be set to the length of the 
  538.   body of the message, if RC is set to zero. 
  539.  
  540.  
  541. ΓòÉΓòÉΓòÉ 4.19. GET_CONTROL_LENGTH ΓòÉΓòÉΓòÉ
  542.  
  543. address MSGAPI 'GET_CONTROL_LENGTH' 'message_handle' 'length'
  544.  
  545. Where: 
  546.  
  547. o message_handle is the NAME of a Rexx variable. This should contain a value 
  548.   obtained from OPEN_MSG. 
  549.  
  550. o length is the NAME of a Rexx variable. This will be set to the length of the 
  551.   control information of the message, if RC is set to zero. 
  552.  
  553.  
  554. ΓòÉΓòÉΓòÉ 4.20. GET_CURRENT_MSG ΓòÉΓòÉΓòÉ
  555.  
  556. address MSGAPI 'GET_CURRENT_MSG' 'msg_area' 'msg_num'
  557.  
  558. Where: 
  559.  
  560. o msg_area is the NAME of a Rexx variable. This should contain a value obtained 
  561.   from OPEN_AREA. 
  562.  
  563. o msg_num is the NAME of a Rexx variable. This will be set to the message 
  564.   number if RC is set to zero. 
  565.  
  566.  
  567. ΓòÉΓòÉΓòÉ 4.21. GET_NUMBER_MSGS ΓòÉΓòÉΓòÉ
  568.  
  569. address MSGAPI 'GET_NUMBER_MSGS' 'msg_area' 'number'
  570.  
  571. Where: 
  572.  
  573. o msg_area is the NAME of a Rexx variable. This should contain a value obtained 
  574.   from OPEN_AREA. 
  575.  
  576. o number is the NAME of a Rexx variable. This will be set to the number of 
  577.   messages in the area, if RC is set to zero. 
  578.  
  579.  
  580. ΓòÉΓòÉΓòÉ 4.22. GET_HIGH_MSG ΓòÉΓòÉΓòÉ
  581.  
  582. address MSGAPI 'GET_HIGH_MSG' 'msg_area' 'number'
  583.  
  584. Where: 
  585.  
  586. o msg_area is the NAME of a Rexx variable. This should contain a value obtained 
  587.   from OPEN_AREA. 
  588.  
  589. o number is the NAME of a Rexx variable. This will be set to the number of the 
  590.   highest message in the area, if RC is set to zero. 
  591.  
  592.  
  593. ΓòÉΓòÉΓòÉ 4.23. VALIDATE ΓòÉΓòÉΓòÉ
  594.  
  595. address MSGAPI 'VALIDATE' 'type' 'msg_area_name'
  596.  
  597. Where: 
  598.  
  599. o 
  600.  
  601.   msg_area_name is the name of a squish or *.msg area. This name should be a 
  602.   *.MSG directory name or a squish base name, as per squish.cfg. It is NOT the 
  603.   TAG name. 
  604.  
  605. o type is the type of message area. Possible values are: 
  606.  
  607.    SQUISH Squish format area 
  608.    SDM    *.MSG format area 
  609.    SDMECHO *.MSG format echomail area (1.MSG contains a highwatermark) 
  610.  
  611. RC will be set to 0 if the area exists and is valid. 
  612.  
  613.  
  614. ΓòÉΓòÉΓòÉ 4.24. VALID_MESSAGE_HANDLE ΓòÉΓòÉΓòÉ
  615.  
  616. address MSGAPI 'VALID_MESSAGE_HANDLE' 'message_handle'
  617.  
  618. Where: 
  619.  
  620. o message_handle is the NAME of a Rexx variable. This should contain a value 
  621.   obtained from OPEN_MSG. 
  622.  
  623. RC will be set to 0 if the handle is valid. 
  624.  
  625.  
  626. ΓòÉΓòÉΓòÉ 4.25. VALID_AREA_HANDLE ΓòÉΓòÉΓòÉ
  627.  
  628. address MSGAPI 'VALID_AREA_HANDLE' 'msg_area'
  629.  
  630. Where: 
  631.  
  632. o msg_area is the NAME of a Rexx variable. This should contain a value obtained 
  633.   from OPEN_AREA. 
  634.  
  635. RC will be set to 0 if the handle is valid.