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

This commit is contained in:
Rob Shearman 2007-03-26 18:23:51 +01:00 committed by Alexandre Julliard
parent 1b8537bebd
commit cdc9367d78
2 changed files with 46 additions and 1 deletions

View File

@ -541,7 +541,18 @@ static HRESULT BindCtxImpl_Construct(BindCtxImpl* This)
/****************************************************************************** /******************************************************************************
* CreateBindCtx (OLE32.@) * 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) HRESULT WINAPI CreateBindCtx(DWORD reserved, LPBC * ppbc)
{ {
BindCtxImpl* newBindCtx = 0; BindCtxImpl* newBindCtx = 0;
@ -576,6 +587,21 @@ HRESULT WINAPI CreateBindCtx(DWORD reserved, LPBC * ppbc)
return hr; 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 WINAPI BindMoniker(LPMONIKER pmk, DWORD grfOpt, REFIID riid, LPVOID * ppvResult)
{ {
HRESULT res; HRESULT res;

View File

@ -736,6 +736,16 @@ RunningObjectTableImpl_EnumRunning(IRunningObjectTable* iface,
/*********************************************************************** /***********************************************************************
* GetRunningObjectTable (OLE32.@) * 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 HRESULT WINAPI
GetRunningObjectTable(DWORD reserved, LPRUNNINGOBJECTTABLE *pprot) GetRunningObjectTable(DWORD reserved, LPRUNNINGOBJECTTABLE *pprot)
@ -758,6 +768,15 @@ GetRunningObjectTable(DWORD reserved, LPRUNNINGOBJECTTABLE *pprot)
/****************************************************************************** /******************************************************************************
* OleRun [OLE32.@] * 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) HRESULT WINAPI OleRun(LPUNKNOWN pUnknown)
{ {