home *** CD-ROM | disk | FTP | other *** search
/ Liren Large Software Subsidy 5 / 05.iso / a / a522 / 33.ddi / IFUSER.H < prev    next >
Encoding:
C/C++ Source or Header  |  1990-11-09  |  2.5 KB  |  88 lines
  1. /* Copyright (c) 1990 by Oracle Corporation */
  2.  
  3. /* NAME
  4.     IFUSER.H -- SQL*Forms User routine interface
  5.  
  6.    FUNCTION
  7.     Provides prototypes, macros, constants, and types for user exit
  8.     callbacks to SQL*Forms (Runform).
  9.  
  10.    NOTES
  11.     Watch out for name conflicts on the macros.
  12.  
  13.    MODIFIED
  14.     Stein      08/16/90 - Creation
  15. */
  16.  
  17. #ifndef IFUSER
  18. #define IFUSER
  19.  
  20. /*
  21. ** IFURC_xxx -- SQL*Forms User Return Codes
  22. **
  23. ** These values are returned by the various entry points described
  24. ** below.
  25. */
  26. #define IFURC_SUCCESS    0    /* The call was successful */
  27. #define IFURC_FAILURE    1    /* The call failed */
  28. #define IFURC_UNKNOWN    2    /* The operation code is unknown */
  29.  
  30.  
  31. /*
  32. ** IFUTRM -- SQL*Forms User TeRMinal operations
  33. **
  34. ** This routine can be called by user exits to perform various terminal
  35. ** operations.  The operation codes are given by the IFUOP_xxx constants.
  36. **
  37. ** This routine takes a variable number of arguments based on the
  38. ** operation performed.  For each operation, the arguments required are
  39. ** described below with the operation constant.
  40. **
  41. ** One of the IFURC_xxx return codes is returned by this function.  The
  42. ** details are given below for each operation.
  43. */
  44. extern int ifutrm(/*_ int, ... _*/);
  45.  
  46.  
  47. /*
  48. ** IFUOP_xxx -- Operation constants
  49. **
  50. ** These constants are used by user exits to tell SQL*Forms (Runform)
  51. ** what operation should performed.  These constants are given to the
  52. ** various SQL*Forms entry points.
  53. **
  54. ** For each constant, the entry point to use is given and a prototype
  55. ** for its arguments (if any) is described.
  56. */
  57.  
  58. #define IFUOP_SUSPEND    1
  59. /*
  60.    ifutrm(IFUOP_SUSPEND)
  61.  
  62.    Suspend SQL*Forms' usage of the terminal and reset it to its default
  63.    state.  This is typically used in a user exit where some terminal
  64.    interaction is necessary (printing and reading characters or starting
  65.    another process such as an editor).  Before returning to SQL*Forms,
  66.    the terminal should be "resumed" with the IFUOP_RESUME operation
  67.    (described below).
  68.  
  69.    NOTE: the terminal should not be suspended if the user exit is going
  70.    to use the SQL*Forms user exit window package.
  71.  
  72.    RETURNS: always returns IFURC_SUCCESS
  73. */
  74.  
  75. #define IFUOP_RESUME    2
  76. /*
  77.    ifutrm(IFUOP_RESUME)
  78.  
  79.    Resume SQL*Forms' usage of the terminal.  This must be called before
  80.    returning to SQL*Forms if the terminal has been suspended with the
  81.    IFUOP_SUSPEND operation.
  82.  
  83.    RETURNS: always returns IFURC_SUCCESS
  84. */
  85.  
  86.  
  87. #endif /* IFUSER */
  88.