home *** CD-ROM | disk | FTP | other *** search
/ CD Direkt 1995 #6 / CDD_6_95.ISO / cdd / winanw / hawin / readme.api < prev    next >
Text File  |  1994-12-07  |  41KB  |  1,223 lines
  1. (The best way to view README.API in Windows Notepad is to
  2. maximize the Notepad window. The best way to print 
  3. README.API is to open this file in Windows Write, Microsoft 
  4. Word, or another word processor, select the entire file, and 
  5. format the text in 10 point Courier before printing.)
  6.  
  7. ------------------------------------------------------------
  8. HyperACCESS for Windows (HA/Win) Version 2.0 README.API File
  9. ------------------------------------------------------------
  10.  
  11. Contents
  12.  
  13. - New API Functions
  14.     haComDriverSpecial (ScriptHandle, pszCmd)
  15.     haCreateNewSession (hScript, pszName)
  16.     haGetLearnFileName (ScriptHandle, nSize, pszBuffer)
  17.     haGetSelectedText (ScriptHandle, nSize, pszBuffer)
  18.     haGetSessionName (ScriptHandle, nSize, pszBuffer)
  19.     haLearnControl (ScriptHandle, nCmd)
  20.     haNotifyOnTerminate (ScriptHandle, hWnd, nMsg)
  21.     haPause (ScriptHandle, lTime)
  22.     haRestrictMenus (ScriptHandle, nMode)
  23.     haSetLearnFileName (ScriptHandle, pszPtr)
  24.     haSetLocalDisplay (ScriptHandle, nFlag)
  25.     haSpawn (hScript, pszName)
  26.  
  27. - Other Include Files
  28.  
  29. - API Examples
  30. -------------------------------------------------------------------------------------------------------------
  31. -------------------------------------------------------------------------------------------------------------
  32. New API Functions
  33.  
  34.  
  35. ------------------
  36. haComDriverSpecial
  37.  
  38.     Passes a device specific command string to the comm driver. 
  39.  
  40.     Syntax:
  41.         haComDriverSpecial (ScriptHandle, LPSTR pszCmd)
  42.  
  43.         SCRIPTHANDLE ScriptHandle    The program - HA\Win link
  44.         LPSTR pszCmd            The command string
  45.  
  46.     Arguments:
  47.  
  48.         ScriptHandle
  49.             The script handle returned from haInitialize.
  50.  
  51.         pszCmD
  52.             The command string that you want to pass to 
  53.             comm driver. Depends on device.
  54.  
  55.     Remarks:
  56.  
  57.     Return Value:
  58.         Standard 
  59.  
  60.     
  61.  
  62. --------------------------
  63. haCreateNewSession
  64.  
  65.     Opens a new session and creates a new session file.
  66.  
  67.     Syntax:
  68.  
  69.         haCreateNewSession(ScriptHandle, pszName)
  70.  
  71.         SCRIPTHANDLE ScriptHandle    The program - HA\Win link
  72.         LPSTR pszName            The name used for the session
  73.  
  74.     Arguments:
  75.  
  76.         ScriptHandle
  77.             The script handle returned from haInitialize.
  78.  
  79.         pszName
  80.             The name of the new session.  This is the name that
  81.             shows up in the title bar of the new session, as well
  82.             as the Phonebook.  It is also used to generate the
  83.             filename, the first eight characters being used, 
  84.             with non alphanumeric characters being replaced by
  85.             an underscore.
  86.  
  87.     Remarks:
  88.  
  89.         The session is not connected when it is initially created.
  90.         The newly created session becomes the current session for 
  91.         the script.  A script can interact with several sessions 
  92.         simultaneously by storing the session handles in variables 
  93.         and using haSetSession to move among them.
  94.  
  95.     Return Value:
  96.  
  97.         Returns a session handle if successful.  Otherwise a 
  98.         standard API error code.
  99.  
  100.     See Also:
  101.  
  102.         haCloseSession, haConnectSession, haOpenSession
  103.  
  104.  
  105.  
  106. ------------------
  107. haGetLearnFileName
  108.  
  109.     Returns the name of the learn file (script) for the currently active 
  110.     session.
  111.  
  112.     Syntax:
  113.  
  114.         INT haGetLearnFileName(ScriptHandle, nSize, pszBuffer)
  115.  
  116.         SCRIPTHANDLE ScriptHandle    The program - HA/Win link
  117.         INT nSize            The size of the following buffer
  118.         LPSTR pszBuffer            A pointer to a buffer
  119.  
  120.     Arguements:
  121.  
  122.         ScriptHandle
  123.  
  124.             The script handle returned from haInitialize.
  125.  
  126.         nSize
  127.  
  128.             The size of the following buffer.
  129.  
  130.         pszBuffer
  131.  
  132.             A pointer to a buffer that is to contain the filename.
  133.  
  134.     Remarks:
  135.  
  136.         The buffer should be large enough to accomodate a complete path 
  137.         and filename.  If the buffer is too small, only as much of the 
  138.          name as will fit will be copied.
  139.  
  140.     Return Value:
  141.  
  142.         Returns 0 if successful.  Otherwise,a standard API error code.
  143.  
  144.     See Also:
  145.  
  146.         haSetLearnFileName, haGetCaptureFileName
  147.  
  148.  
  149.  
  150. -----------------
  151. haGetSelectedText
  152.  
  153.     Get the selected (highlighted) text from the associated session 
  154.     window.
  155.  
  156.     Syntax:
  157.  
  158.         INT haGetSelectedText(ScriptHandle, nSize, pszBuffer)
  159.  
  160.         SCRIPTHANDLE ScriptHandle    The program - HA/Win link
  161.         INT nSize            The size of the following buffer
  162.         LPSTR pszBuffer            A pointer to a buffer
  163.  
  164.     Arguments:
  165.  
  166.         ScriptHandle
  167.             The script handle returned from haInitialize.
  168.  
  169.         nSize
  170.             The size of the following buffer.
  171.  
  172.         pszBuffer
  173.             A pointer to a buffer that is to receive the selected 
  174.             text.
  175.  
  176.     Remarks:
  177.  
  178.         Since there is no way to predict how much text the user is 
  179.         going to select, make the buffer as big as is possible and 
  180.         still be reasonable.  And remember, it still won't be large 
  181.         enough every time.
  182.  
  183.     Return Value:
  184.  
  185.         Returns 0 if successful.  Otherwise a standard API error code.
  186.  
  187.     See Also:
  188.  
  189.         haGetTextFromScreen
  190.  
  191.  
  192. ----------------
  193. haGetSessionName
  194.  
  195.     Returns the name of the current session.
  196.  
  197.     Syntax:
  198.  
  199.         INT haGetSessionName(ScriptHandle, nSize, pszBuffer)
  200.  
  201.         SCRIPTHANDLE ScriptHandle    The program - HA/Win link
  202.         INT nSize            The size of the following buffer
  203.         LPSTR pszBuffer            A pointer to a buffer
  204.  
  205.     Arguments:
  206.  
  207.         ScriptHandle
  208.             The script handle returned from haInitialize.
  209.  
  210.         nSize
  211.             The size of the following buffer.
  212.  
  213.         pszBuffer
  214.             A pointer to a buffer that is to recieve the string.
  215.  
  216.     Remarks:
  217.  
  218.         The session name is the string that is displayed in the title 
  219.         bar of an open session.  It is also displayed in some of the 
  220.         Phonebook views.
  221.  
  222.     Return Value:
  223.  
  224.         Returns 0 if successful.  Otherwise, a standard API error code.
  225.  
  226.     See Also:
  227.  
  228.         haGetSessionDataString
  229.  
  230.  
  231.  
  232. --------------
  233. haLearnControl
  234.  
  235.     Turns learning(recording) on or off for the currently active session.
  236.  
  237.     Syntax:
  238.  
  239.         INT haLearnControl(ScriptHandle, nCmd)
  240.  
  241.             SCRIPTHANDLE ScriptHandle    The program - HA/Win link
  242.             INT nCmd            The control command
  243.  
  244.     Arguements:
  245.  
  246.         ScriptHandle
  247.  
  248.             The script handle returned from haInitialize.
  249.  
  250.         nCmd
  251.  
  252.             This is a constant value that represents the command to 
  253.             be applied to the HA/Win learning(recording) system.
  254.  
  255.             Value            Meaning
  256.             ----------        -------------------------------------
  257.             HA_L_START        Start learning(recording).
  258.  
  259.             HA_L_STOP        Stop learning(recording) and save the 
  260.                         learned script in the default file.
  261.  
  262.             HA_L_ABORT        Stop learning(recording) but do not 
  263.                         save the learned script.
  264.  
  265.     Remarks:
  266.  
  267.     Return Value:
  268.  
  269.         Returns 0 if successful.  Otherwise, a standard API error code.
  270.  
  271.     See Also:
  272.  
  273.         haSetLearnFileName, haCaptureControl
  274.  
  275.  
  276. -------------------
  277. haNotifyOnTerminate
  278.  
  279.     Posts a message to a specified Window when the session closes.
  280.  
  281.     Syntax:
  282.  
  283.         INT haNotifyOnTerminate(ScriptHandle, hWnd, nMsg)
  284.  
  285.         SCRIPTHANDLE ScriptHandle    The program - HA/Win link
  286.         HWND hWnd            A window handle to post to
  287.         INT nMsg            The message to be posted
  288.  
  289.     Arguments:
  290.  
  291.         ScriptHandle
  292.             The script handle returned from haInitialize.
  293.  
  294.         hWnd
  295.             The handle of the window that the following message is 
  296.             to be posted to.
  297.  
  298.         nMsg
  299.             The message that is to be posted to the previous window 
  300.             handle.
  301.  
  302.     Remarks:
  303.  
  304.         Posting messages across tasks is not a standard method in a 
  305.         Windows program.  However, it can sometimes be useful.  In 
  306.         this case, the message is posted if the script handle is still 
  307.         valid and the window handle is still valid.  There is no type 
  308.         of checking done on the message.  It is up to the user to 
  309.         correctly deal with it.
  310.  
  311.     Return Value:
  312.  
  313.         Returns 0 if successful.  Otherwise, a standard API error code.
  314.  
  315.     See Also:
  316.  
  317.         haGetHWND
  318.  
  319.  
  320.  
  321. ------------------
  322. haPause
  323.  
  324.     Causes the API interface to enter the HyperACCESS server idle loop for a 
  325.     specified period of time.
  326.  
  327.     Syntax:
  328.         haPause (ScriptHandle, lTime)
  329.  
  330.         SCRIPTHANDLE ScriptHandle    The program - HA\Win link
  331.         LONG lTime            How long to pause
  332.  
  333.     Arguments:
  334.  
  335.         ScriptHandle
  336.             The script handle returned from haInitialize.
  337.  
  338.         lTime
  339.             The amount of time to pause, measured in milliseconds.
  340.  
  341.  
  342.     Remarks:
  343.         Similar to haSleep. While an application pauses, the session neither
  344.         sends nor receives characters. During this time, however, windows 
  345.         messages continue to be dispatched to prevent