Source code of Windows XP (NT5)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

179 lines
2.7 KiB

  1. @HR = asmFuncWithCallback
  2. This is an imaginary assembler function
  3. to test AUTODOC. It has an associated callback function.
  4. @HO = Registers
  5. @RNAME = <B>AL<D>
  6. @RDESC = Specifies an 8-bit parameter value.
  7. @RDESC = This is the second paragraph of a register description.
  8. @RNAME = <B>BX<D>
  9. @RDESC = Specifies a 16-bit parameter value.
  10. @RNAME = <B>CL<D>
  11. @RDESC = Specifies an 8-bit parameter value using one of the
  12. following flags:
  13. @RFLAG = RED
  14. @RFLDESC = A flag value.
  15. @RFLAG = WHITE
  16. @RFLDESC = Another flag value.
  17. @RNAME = <B>EDX<D>
  18. @RDESC = Specifies a 32-bit pointer to a callback function.
  19. @LE =
  20. @HO = Returns
  21. The following registers contain meaningful return values:
  22. @RNAME = <B>CX<D>
  23. @RDESC = This register should come out before the conditionals are
  24. printed.
  25. @FLAG = FOOBAR
  26. @FLDESC = Random flag before the conditionals.
  27. @LE =
  28. @COND = If AL is zero, the callback was succcessfully installed, and the
  29. following registers contain:
  30. @COND = This is the second paragraph of a conditional.
  31. @RNAME = <B>BX<D>
  32. @RDESC = Specifies a 16-bit return value.
  33. @RNAME = <B>DS:SI<D>
  34. @RDESC = Points to the ASCIIZ name of the callback.
  35. @LE =
  36. @COND = Otherwise, an error is specified as follows:
  37. @RNAME = <B>AL<D>
  38. @RDESC = Contains one of the following error codes:
  39. @FLAG = ERROR1
  40. @FLDESC = An error.
  41. @FLAG = ERROR2
  42. @FLDESC = Another error.
  43. @LE =
  44. @LE =
  45. @HO = Uses
  46. EFLAGS
  47. @LE =
  48. @HO = Comments
  49. Here are some comments pertaining to this function. <B>This
  50. sentence should be bold. <MI>This sentence should be italicized.<D>
  51. This is the second paragraph of comments. The callback function is
  52. specified as follows:
  53. @HO = Callback
  54. <B>asmCallback<D>
  55. The name <B>asmCallback<D> is a placeholder for
  56. the application-supplied callback function.
  57. @HU = Registers
  58. @RNAME = <B>AL<D>
  59. @RDESC = Specifies an 8-bit parameter value.
  60. @RNAME = <B>BX<D>
  61. @RDESC = Specifies a 16-bit parameter value.
  62. @RNAME = <B>CL<D>
  63. @RDESC = Specifies an 8-bit parameter value using one of the
  64. following flags:
  65. @RFLAG = RED
  66. @RFLDESC = A flag value.
  67. @RFLAG = WHITE
  68. @RFLDESC = Another flag value.
  69. @LE =
  70. @HU = Returns
  71. The following registers contain meaningful return values:
  72. @RNAME = <B>AL<D>
  73. @RDESC = If zero, the callback was successfully installed.
  74. Otherwise, an error is specified by one of the following flags:
  75. @FLAG = ERROR1
  76. @FLDESC = An error.
  77. @FLAG = ERROR2
  78. @FLDESC = Another error.
  79. @LE =
  80. @COND = This is an empty conditional to test the code.
  81. None
  82. @LE =
  83. @COND = Otherwise, the following registers are returned:
  84. @RNAME = <B>BX<D>
  85. @RDESC = Specifies a 16-bit return value.
  86. @LE =
  87. @LE =
  88. @HU = Uses
  89. EFLAGS
  90. @LE =
  91. @HU = Comments
  92. Here are some comments pertaining to the callback function.
  93. @HO = See Also
  94. asmFunc