home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD2.mdf / c / library / mslang / cscrap / readme.txt < prev    next >
Encoding:
Text File  |  1994-05-11  |  8.2 KB  |  208 lines
  1. ==============================================================
  2.  
  3.    Copyright 1994  Northeast Data Corp.  All Rights Reserved
  4.  
  5. ==============================================================
  6.  
  7.  
  8.                      Scraper Custom Control V1.1
  9.  
  10.  
  11. The Scraper control allows you to extract data from another
  12. application. This is useful for integrating applications that cannot
  13. be integrated via DDE, OLE, or other means. The control operates by
  14. allowing the user to select a target window in a different application.
  15. By commanding the control, your application can extract data from the
  16. other application and use this data as it sees fit.
  17.  
  18. For example, to integrate imaging into a database application, you could
  19. write an image display application that uses the Scraper control. The
  20. Scraper control would allow the user to select a window in the database
  21. application that contains the file name of a .TIF file. When the user
  22. presses the VIEW button in your application, you command the Scraper 
  23. control to extract the file name from the database application window.
  24. Then you display the selected file in your application.
  25.  
  26. The Scraper control conforms to the standard for custom controls used
  27. with the Microsoft SDC Dialog Editor. The control is also available as
  28. a VBX control for use with Microsoft Visual Basic and Visual C++.
  29.  
  30. The only difference between the demo version of the control and
  31. the commercial version is that the demo version displays a
  32. dialog box that allows the user to register the control with
  33. Northeast Data. There are no other functional differences.
  34.  
  35.    
  36. ===================
  37. The demo version    
  38. ===================
  39. (Does not apply if you have purchased a licensed version)
  40.  
  41. The demo version of the control will allow you to perform all functions
  42. implemented by the commercial version. The only difference is that a
  43. registration dialog box is displayed when the control is first loaded.
  44.  
  45. By registering the control with Northeast Data Corp., you get:
  46.  
  47.    - The commercial version of the control
  48.    - A telephone and FAX number for support
  49.    - A Compuserve ID for support
  50.    - Free maintenance release updates
  51.    - A discount on major releases
  52.    - More information about using NetBIOS
  53.  
  54.  
  55. ===================
  56. System Requirements
  57. ===================
  58. Microsoft Windows version 3.0, 3.1 or higher.
  59.  
  60.  
  61. ===================
  62. Installation
  63. ===================
  64.  
  65. Copy the CSCRAPER.DLL file to your Windows or Windows\System directory.
  66.  
  67. Start Windows and run the TEST.EXE program supplied with the Scraper 
  68. control.
  69.  
  70. For developing your own application, you can use the SDK Dialog Editor
  71. to place Scraper controls into a dialog box. You can also create a 
  72. Scraper window by using the Windows CreateWindow API function just as
  73. you would with other standard controls.
  74.  
  75.  
  76. ===================
  77. Control Messages
  78. ===================
  79.  
  80. These messages and values for wParam and lParam are defined in the scraper.h
  81. file:
  82.  
  83.    SCM_SETACTION
  84.  
  85.       Specified what kind of action will be taken by the Scraper control
  86.       when the "scrape" command is performed (see below). The action is
  87.       specified in wParam and can be:
  88.  
  89.       
  90.       0 - Get window text. Retrieves the caption from the target window.
  91.  
  92.       1 - Get button state. Returns "1" if a button is checked or "0" if
  93.          it is not checked. This applies to radio buttons and check boxes.
  94.  
  95.       2 - Get selected listox item. Returns the text for the current selected
  96.          item in a listbox.
  97.  
  98.       3 - Get edit text. Returns the text entered into an edit box. This action
  99.          also returns the text that is currently selected in a combo box.
  100.  
  101.       The action you specify is stored permanently in the scraper.ini file.
  102.  
  103.  
  104.    SCM_SETCOMMAND
  105.  
  106.       Specifies a command for the Scraper control to perform. wParam
  107.       contains the specific command and can be:
  108.  
  109.       1 - Configure
  110.  
  111.          Displays a dialog box that allows the user to choose a window
  112.          to scrape. The only windows the user will be allowed to choose
  113.          are those owned by other applications.
  114.  
  115.       2 - Scrape
  116.  
  117.          Extracts the data from the target application window. The data
  118.          is stored in the Scraper control. If this function is successful,
  119.          you can send the SCM_GETDATA message to get the scraped data.
  120.          
  121.          Errors returned from this message are:
  122.  
  123.             ERR_TASKNOTFOUND - The application that is being scraped is
  124.                                not running, or the application executable
  125.                                file has been moved to a different directory
  126.                                from where it was when the Scraper control
  127.                                was configured.
  128.  
  129.             ERR_WINDOWNOTFOUND - The specified window cannot be found. This
  130.                                  may occur if the target application has
  131.                                  moved the window to a different location
  132.                                  from its original position, or if the
  133.                                  window that was configured is not
  134.                                  currently visible in the target application.
  135.  
  136.  
  137.    SCM_SETSCRAPEID
  138.    
  139.       Sets the ID of the information for the target window to the
  140.       string you specify in lParam (NULL-terminated). You can use
  141.       this name to refer to the target window that you want to scrape.
  142.       By using several IDs, you can scrape any number of windows in
  143.       the target application. You can also achieve this by using 
  144.       multiple Scraper controls, which avoids update of the scraper.ini
  145.       file every time you change the scrape ID.
  146.  
  147.    SCM_GETSCRAPEID
  148.  
  149.       Gets the name of the information for the target window that Scraper
  150.       is currently configured to scrape.
  151.  
  152.    SCM_GETDATA
  153.  
  154.       Gets the data that was most recently scraped. You specify the address
  155.       of a buffer in lParam and its length in wParam. Scraper returns the
  156.       actual length of the data in the function result to your 
  157.       SendMessage call.
  158.  
  159.       Errors that can occur from this message are:
  160.  
  161.          ERR_NODATA - The target window has not been scraped; there is
  162.                       no data to return.
  163.  
  164.  
  165. =============================
  166. General Notes
  167. =============================
  168. The "Target" application and "Target" window are those that are chosen by
  169. the user from the configuration dialog box. All information about the
  170. chosen window is stored in the scraper.ini file. The sections in this file
  171. are identified using the ScraperID property value.
  172.  
  173. The Scraper control stores all the information about the selected target
  174. window. When your application commands the Scraper to scrape the target
  175. window, the Scraper control tries to find the window that was specified
  176. during configuration (selection of the target window). Because there is
  177. no positive way to identify the target window (MS Windows does not keep
  178. specific window identifiers between application invocations), Scraper does
  179. the best it can to locate the desired window. Usually, it can locate the
  180. window based on its relationship to other task windows. If it cannot locate
  181. the window, it will return an error code to the application. The application
  182. will then have to prompt the user to re-select the desired window.
  183.  
  184. Data can only be scraped from a target application's windows. If the
  185. target application displays data without using standard Windows controls,
  186. there is no way Scraper can extract that data. For example, the 
  187. Microsoft Word and Excel applications do not display data in standard
  188. Windows controls (edit controls, etc.). Although you can extract data 
  189. from dialog boxes and other windows within these applications, you cannot
  190. extract data that is simply written to the screen.
  191.  
  192. The configuration dialog box displays information about the target window
  193. that is probably not useful to many users. This information is presented
  194. for those who may be able to use it.
  195.  
  196.  
  197.    ================================================================
  198.  
  199.       Northeast Data Corp.
  200.       2117 Buffalo Rd., Suite 290
  201.       Rochester, NY  14624
  202.       716-247-5934 (phone & FAX)
  203.  
  204.    ================================================================
  205.  
  206.    April 3, 1994
  207.  
  208.