home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / iwftech.zip / headers / wkfins.h < prev    next >
Text File  |  1994-07-21  |  11KB  |  157 lines
  1. /****************************************************************************/
  2. /* Integration Kit for IBM* WorkFrame/2* Version 2.1                        */
  3. /*                                                                          */
  4. /* The integration kit contains an information reference and sample         */
  5. /* programs illustrating application programming interfaces to              */
  6. /* provide assistance with product integration into IBM's                   */
  7. /* WorkFrame/2 Version 2.1.                                                 */
  8. /*                                                                          */
  9. /* The information and sample programs are intended only for                */
  10. /* Version 2.1, and are not applicable to any other IBM product or          */
  11. /* product release.                                                         */
  12. /*                                                                          */
  13. /* The integration kit is provided as is, without any warranty of           */
  14. /* merchantibility of fitness for any particular purpose. The kit           */
  15. /* includes sample code. This code has not been tested, and IBM             */
  16. /* makes no representation of its workability or fitness on any             */
  17. /* system.                                                                  */
  18. /*                                                                          */
  19. /* You are permitted to make copies of the whole of this kit,               */
  20. /* including this notice screen. You are also permitted to copy the         */
  21. /* sample programs, and their source, contained in the kit for the          */
  22. /* purpose of running those programs on your system.                        */
  23. /*                                                                          */
  24. /* You may distribute copies of the whole of this kit, or only of the       */
  25. /* sample programs, in any country recognising the copyright of U.S.        */
  26. /* nationals. Any copies distributed by you must include a copy of          */
  27. /* this notice screen.                                                      */
  28. /*                                                                          */
  29. /* IBM will attempt to make future releases of the WorkFrame/2              */
  30. /* product compatible, but cannot guarantee upward compatibility.           */
  31. /*                                                                          */
  32. /* COPYRIGHT: IBM WorkFrame/2 Version 2.1                                   */
  33. /*            (C) COPYRIGHT IBM CORP 1990, 1991, 1992, 1993, 1994           */
  34. /*            LICENSED MATERIALS - PROPERTY OF IBM                          */
  35. /*            REFER TO COPYRIGHT INSTRUCTIONS FORM NUMBER G120-2083         */
  36. /*                                                                          */
  37. /* ------------------------------------------------------------------------ */
  38. /*                                                                          */
  39. /* MODULE:    WKFINS.H - WorkFrame Support Installation interfaces          */
  40. /*                                                                          */
  41. /*                                                                          */
  42. /****************************************************************************/
  43.  
  44. #ifndef _WKFINS_H_
  45.    #define _WKFINS_H_
  46.  
  47.    #define MAJ_VERKEY    "Major Version"
  48.    #define MIN_VERKEY    "Minor Version"
  49.  
  50.  
  51.    /* -------------------------------------------------------------------- */
  52.    /* WkfQueryInstalledVersion: return the currently installed WF          */
  53.    /* -------------------------------------------------------------------- */
  54.    /*                                                                      */
  55.    /* Parameters:                                                          */
  56.    /* ----------                                                           */
  57.    /* PSZ   pszDirectory - pointer to the buffer containing the            */
  58.    /*                      the fully qualified path name of the WF's       */
  59.    /*                      installation directory. This buffer should be   */
  60.    /*                      at least CCHMAXPATH large to ensure success     */
  61.    /* ULONG ulDirectory  - size of the above buffer                        */
  62.    /* ULONG * pulMajorVersion - major version number returned              */
  63.    /* ULONG * pulMinorVersion - minor version number returned              */
  64.    /* BOOL  OnlyVersion1 - Set to TRUE, if you want to only look for       */
  65.    /*                      the location of WF version 1.                   */
  66.    /*                      If set to FALSE, then the most up to date       */
  67.    /*                      version of the WF is located.                   */
  68.    /*                                                                      */
  69.    /* Returns:                                                             */
  70.    /* -------                                                              */
  71.    /* BOOL  TRUE  if WF found                                              */
  72.    /*       FALSE if requested WF version not found                        */
  73.    /*                                                                      */
  74.    /* NOTE:                                                                */
  75.    /* ----                                                                 */
  76.    /* This function is not shipped in any of WF's DLLs.  The object module */
  77.    /* is statically available in wf21.lib.  Hence, this function can be    */
  78.    /* called whether WF is installed or not.                               */
  79.    /*                                                                      */
  80.    /* -------------------------------------------------------------------- */
  81.    extern BOOL APIENTRY WkfQueryInstalledVersion( PSZ  pszDirectory,
  82.                                           ULONG  ulDirectory,
  83.                                           PULONG pulMajorVersion,
  84.                                           PULONG pulMinorVersion,
  85.                                           BOOL   OnlyVersion1 );
  86.  
  87.  
  88.    /* -------------------------------------------------------------------- */
  89.    /* Macros used for setting default options when using DDE3DEF2.DLL      */
  90.    /* as the tool support dll                                              */
  91.    /* -------------------------------------------------------------------- */
  92.    #define WKFDEF2_APPNAME_TEMPLATE   "%s::%s"  /* Action_Class::EXE_name  */
  93.  
  94.    #define WKFDEF2_DEFAULTS "Wkf.Defaults"
  95.  
  96.    #define WKFDEF2_PARMS    "Wkf.CmdLine"       /* command line parameters */
  97.  
  98.    #define WKFDEF2_ERRTEMPL "Wkf.Errors"        /* error line template     */
  99.  
  100.    #define WKFDEF2_PROMPT   "Wkf.Prompt"        /* prompt required flag    */
  101.    #define WKFDEF2_PROMPT_YES "1"
  102.    #define WKFDEF2_PROMPT_NO  "0"
  103.  
  104.    #define WKFDEF2_EDITDDE  "Wkf.EditDDE"       /* tool supports editor DDE*/
  105.    #define WKFDEF2_EDITDDE_YES "1"
  106.    #define WKFDEF2_EDITDDE_NO  "0"
  107.  
  108.    #define WKFDEF2_FILE "%s\\DDE3DEF2.INI"
  109.  
  110.    /* -------------------------------------------------------------------- */
  111.    /* WkfSetDefaultOption: set default options when using DDE3DEF2         */
  112.    /* -------------------------------------------------------------------- */
  113.    /*                                                                      */
  114.    /* Parameters:                                                          */
  115.    /* ----------                                                           */
  116.    /*   HAB     hAB               - caller's anchor block or NULLHANDLE;   */
  117.    /*                               if NULLHANDLE is passed, then this     */
  118.    /*                               function will create its own hAB       */
  119.    /*   PSZ     pszActionClass    - action class of the tool, e.g. "EDIT"  */
  120.    /*   PSZ     pszEXEName        - UNQUALIFIED program file name (no ext.)*/
  121.    /*                               e.g. "EPM"                             */
  122.    /*   PSZ     pszParameters     - parameters to the program,             */
  123.    /*                               e.g. "/W %a %z"                        */
  124.    /*   PSZ     pszErrorTemplate  - error template (see default dialog     */
  125.    /*                               for details)                           */
  126.    /*   PSZ     pszPromptOnRun    - set to WKFDEF2_PROMPT_YES to prompt    */
  127.    /*                               the user for parameters prior to tool  */
  128.    /*                               invocation                             */
  129.    /*                             - set to WKFDEF2_PROMPT_NO to invoke     */
  130.    /*                               the the tool without promption         */
  131.    /*   PSZ     pszSupportDDE     - set to WKFDEF2_EDITDDE_YES if this     */
  132.    /*                               tool support WF DDE protocols          */
  133.    /*                             - set to WKFDEF2_EDITDDE_NO for non      */
  134.    /*                               EDIT class tools or for EDIT class     */
  135.    /*                               tools which do not support WF DDE      */
  136.    /*                                                                      */
  137.    /* Returns:                                                             */
  138.    /* -------                                                              */
  139.    /* BOOL  TRUE  if successfully set                                      */
  140.    /*       FALSE if unable to set the default options                     */
  141.    /*                                                                      */
  142.    /* NOTE:                                                                */
  143.    /* ----                                                                 */
  144.    /* This function is not shipped in any of WF's DLLs.  The object module */
  145.    /* is statically available in wf21.lib.                                 */
  146.    /*                                                                      */
  147.    /* -------------------------------------------------------------------- */
  148.    extern BOOL APIENTRY WkfSetDefaultOption( HAB hAB,
  149.                                              PSZ pszActionClass,
  150.                                              PSZ pszEXEName,
  151.                                              PSZ pszParameters,
  152.                                              PSZ pszErrorTemplate,
  153.                                              PSZ pszPromptOnRun,
  154.                                              PSZ pszSupportDDE );
  155.  
  156. #endif
  157.