home *** CD-ROM | disk | FTP | other *** search
/ Millennium Time Capsule / AC2000.BIN / disks / ac9_disk / net157 / incspec.txt < prev    next >
Encoding:
Text File  |  1997-10-23  |  2.4 KB  |  72 lines
  1. ************************************************************************
  2. * INCSPEC.TXT - this file contains the command syntaxs of the include 
  3. * file's commands
  4. ************************************************************************
  5.  
  6. Please note that this file automatically includes the library 
  7. NetWorld. It also defines all variables as INTegers and includes 
  8. TRANSPRT.BH. A global variable called STIKINITIALISED contains the 
  9. status of STiK - 1 if everything is OK, or a negitive error code 
  10. number (which has nothing to do with the built in error codes!).
  11.  
  12. FUNCTION gerrtxt$ (er%)
  13.  
  14. Returns the STiK error ER as a string.
  15.  
  16. FUNCTION gvstr$ (er$)
  17.  
  18. Returns a STiK internal configuration as a string. For example, if you 
  19. want to get the users email address:
  20.  
  21. email$=gvstr$("EMAIL")
  22.  
  23. For me, email$ now contains "paulat.jones@zetnet.co.uk".
  24.  
  25. FUNCTION tcp_author$
  26.  
  27. Returns as a string the author's name of the TCP transport layer. 
  28. Currently this is Dan Ackerman.
  29.  
  30. FUNCTION tcp_version$
  31.  
  32. Returns as a string the version number of the TCP transport layer.
  33.  
  34. FUNCTION tcp_module$
  35.  
  36. Returns information, as a string, about the TCP transport layer 
  37. module.
  38.  
  39. FUNCTION networldver$
  40.  
  41. Returns as a string the NetWorld version number.
  42.  
  43. FUNCTION TCP_connect% (domain$, port, tos, alloc)
  44.  
  45. Connects to a domain named DOMAIN$ on port PORT with the Type of 
  46. Service as TOS and amount of memory to allocate as ALLOC. This uses 
  47. both resolve and TCP_open. Returns the handle number if positive, or 
  48. -1 if an error occured.
  49.  
  50. FUNCTION get_response$ (cn, time)
  51.  
  52. Gets a string from the server. This is useful after sending a line 
  53. with TCPsend below. CN is the channel, and TIME is the amount in time 
  54. (in seconds) to wait for, before a time out error is sent back. 
  55. Returned is the string from the server OR the text version of an error 
  56. message! NOTE: I couldn't get this command to run correctly on HBASIC 
  57. v1, so I've left it out. If anyone can figure out why, please let me 
  58. know. 
  59.  
  60. FUNCTION TCPsend (cn, message$)
  61.  
  62. Please don't confuse this with TCP_send. This sends the message 
  63. MESSAGE$ to channel CN. This is useful with get_response$ above. This 
  64. command automatically adds chr$(13) and chr$(10) to it, calculates the 
  65. length and sends it.
  66.  
  67. SUB initnetworld
  68.  
  69. Sets up NetWorld. If STiK is not installed correctly, stikinitialised 
  70. will be a negitive error. NOTE: the include file will automatically 
  71. call this sub routine for you.
  72.