Rob Shearman : ole32: Add documentation for CreateBindCtx, BindMoniker, GetRunningObjectTable and OleRun.

[Alexandre Julliard]

Module: wine
Branch: master
Commit: cdc9367d78a178abbfa7b6d020e65fc6836de39b
URL:    http://source.winehq.org/git/wine.git/?a=commit;h=cdc9367d78a178abbfa7b6d020...

Author: Rob Shearman 
Date:   Mon Mar 26 18:23:51 2007 +0100

ole32: Add documentation for CreateBindCtx, BindMoniker, GetRunningObjectTable and OleRun.

---

dlls/ole32/bindctx.c |   28 +++++++++++++++++++++++++++-
 dlls/ole32/moniker.c |   19 +++++++++++++++++++
 2 files changed, 46 insertions(+), 1 deletions(-)

diff --git a/dlls/ole32/bindctx.c b/dlls/ole32/bindctx.c
index 6e87128..da68f33 100644
--- a/dlls/ole32/bindctx.c
+++ b/dlls/ole32/bindctx.c
@@ -541,7 +541,18 @@ static HRESULT BindCtxImpl_Construct(BindCtxImpl* This)

/******************************************************************************
  *        CreateBindCtx (OLE32.@)
- ******************************************************************************/
+ *
+ * Creates a bind context. A bind context encompasses information and options
+ * used when binding to a moniker.
+ *
+ * PARAMS
+ *  reserved [I] Reserved. Set to 0.
+ *  ppbc     [O] Address that receives the bind context object.
+ *
+ * RETURNS
+ *  Success: S_OK.
+ *  Failure: Any HRESULT code.
+ */
 HRESULT WINAPI CreateBindCtx(DWORD reserved, LPBC * ppbc)
 {
     BindCtxImpl* newBindCtx = 0;
@@ -576,6 +587,21 @@ HRESULT WINAPI CreateBindCtx(DWORD reserved, LPBC * ppbc)
     return hr;
 }

+/******************************************************************************
+ *              BindMoniker        [OLE32.@]
+ *
+ * Binds to a moniker.
+ *
+ * PARAMS
+ *  pmk      [I] Moniker to bind to.
+ *  grfOpt   [I] Reserved option flags. Set to 0.
+ *  riid     [I] ID of the interface to bind to.
+ *  pvResult [O] Address that receives the interface of the object that was bound to.
+ *
+ * RETURNS
+ *  Success: S_OK.
+ *  Failure: Any HRESULT code.
+ */
 HRESULT WINAPI BindMoniker(LPMONIKER pmk, DWORD grfOpt, REFIID riid, LPVOID * ppvResult)
 {
     HRESULT res;
diff --git a/dlls/ole32/moniker.c b/dlls/ole32/moniker.c
index 0cb35fa..d34860d 100644
--- a/dlls/ole32/moniker.c
+++ b/dlls/ole32/moniker.c
@@ -736,6 +736,16 @@ RunningObjectTableImpl_EnumRunning(IRunningObjectTable* iface,

/***********************************************************************
  *           GetRunningObjectTable (OLE32.@)
+ *
+ * Retrieves the global running object table.
+ *
+ * PARAMS
+ *  reserved [I] Reserved. Set to 0.
+ *  pprot    [O] Address that receives the pointer to the running object table.
+ *
+ * RETURNS
+ *  Success: S_OK.
+ *  Failure: Any HRESULT code.
  */
 HRESULT WINAPI
 GetRunningObjectTable(DWORD reserved, LPRUNNINGOBJECTTABLE *pprot)
@@ -758,6 +768,15 @@ GetRunningObjectTable(DWORD reserved, LPRUNNINGOBJECTTABLE *pprot)

/******************************************************************************
  *              OleRun        [OLE32.@]
+ *
+ * Set the OLE object to the running state.
+ *
+ * PARAMS
+ *  pUnknown [I] OLE object to run.
+ *
+ * RETURNS
+ *  Success: S_OK.
+ *  Failure: Any HRESULT code.
  */
 HRESULT WINAPI OleRun(LPUNKNOWN pUnknown)
 {