James Hawkins : advpack: Document RegisterOCX.

[Alexandre Julliard]

Module: wine
Branch: refs/heads/master
Commit: 640b7761eb874b2cbda2e67e8c712c89abc9df17
URL:    http://source.winehq.org/git/?p=wine.git;a=commit;h=640b7761eb874b2cbda2e67e8c712c89abc9df17

Author: James Hawkins <truiken at gmail.com>
Date:   Thu Apr 13 22:32:23 2006 -0500

advpack: Document RegisterOCX.

---

 dlls/advpack/advpack.c |   18 ++++++++++++++++++
 1 files changed, 18 insertions(+), 0 deletions(-)

diff --git a/dlls/advpack/advpack.c b/dlls/advpack/advpack.c
index b84717f..eb8ca31 100644
--- a/dlls/advpack/advpack.c
+++ b/dlls/advpack/advpack.c
@@ -394,6 +394,24 @@ HRESULT WINAPI RebootCheckOnInstallW(HWN
 
 /***********************************************************************
  *             RegisterOCX    (ADVPACK.@)
+ *
+ * Registers an OCX.
+ *
+ * PARAMS
+ *   hWnd    [I] Handle to the window used for the display.
+ *   hInst   [I] Instance of the process.
+ *   cmdline [I] Contains parameters in the order OCX,reboot,install_cmd
+ *   show    [I] How the window should be shown.
+ *
+ * RETURNS
+ *   This function does not return anything.
+ *
+ * NOTES
+ *   OCX - Filename of the OCX to register.
+ *   reboot - smart reboot behavior
+ *    'I' Reboot if needed.
+ *    'N' No reboot.
+ *   install_cmd - Command line to pass to the OCX's DllInstall.
  */
 void WINAPI RegisterOCX(HWND hWnd, HINSTANCE hInst, LPCSTR cmdline, INT show)
 {