Skip to content

Latest commit

 

History

History
97 lines (71 loc) · 4.33 KB

nf-objbase-getrunningobjecttable.md

File metadata and controls

97 lines (71 loc) · 4.33 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name req.apiset
NF:objbase.GetRunningObjectTable
GetRunningObjectTable function (objbase.h)
Returns a pointer to the IRunningObjectTable interface on the local running object table (ROT).
GetRunningObjectTable
GetRunningObjectTable function [COM]
_com_GetRunningObjectTable
com.getrunningobjecttable
objbase/GetRunningObjectTable
com\getrunningobjecttable.htm
com
65d9cf7d-cc8a-4199-9a4a-7fd67ef8872d
12/05/2018
GetRunningObjectTable, GetRunningObjectTable function [COM], _com_GetRunningObjectTable, com.getrunningobjecttable, objbase/GetRunningObjectTable
objbase.h
Windows
Windows 2000 Professional [desktop apps only]
Windows 2000 Server [desktop apps only]
Ole32.lib
Ole32.dll
Windows
19H1
GetRunningObjectTable
objbase/GetRunningObjectTable
c++
APIRef
kbSyntax
DllExport
Ole32.dll
Ext-MS-Win-COM-OLE32-l1-1-0.dll
Ext-MS-Win-COM-OLE32-l1-1-1.dll
Ext-MS-Win-COM-OLE32-l1-1-2.dll
ext-ms-win-com-ole32-l1-1-3.dll
Ext-MS-Win-Com-Ole32-L1-1-4.dll
GetRunningObjectTable
ext-ms-win-com-ole32-l1-1-0 (introduced in Windows 8)

GetRunningObjectTable function

-description

Returns a pointer to the IRunningObjectTable interface on the local running object table (ROT).

-parameters

-param reserved [in]

This parameter is reserved and must be 0.

-param pprot [out]

The address of an IRunningObjectTable* pointer variable that receives the interface pointer to the local ROT. When the function is successful, the caller is responsible for calling Release on the interface pointer. If an error occurs, *pprot is undefined.

-returns

This function can return the standard return values E_UNEXPECTED and S_OK.

-remarks

Each workstation has a local ROT that maintains a table of the objects that have been registered as running on that computer. This function returns an IRunningObjectTable interface pointer, which provides access to that table.

Moniker providers, which hand out monikers that identify objects so they are accessible to others, should call GetRunningObjectTable. Use the interface pointer returned by this function to register your objects when they begin running, to record the times that those objects are modified, and to revoke their registrations when they stop running. See the IRunningObjectTable interface for more information.

Compound-document link sources are the most common example of moniker providers. These include server applications that support linking to their documents (or portions of a document) and container applications that support linking to embeddings within their documents. Server applications that do not support linking can also use the ROT to cooperate with container applications that support linking to embeddings.

If you are implementing the IMoniker interface to write a new moniker class, and you need an interface pointer to the ROT, call IBindCtx::GetRunningObjectTable rather than the GetRunningObjectTable function. This allows future implementations of the IBindCtx interface to modify binding behavior.

-see-also

IBindCtx::GetRunningObjectTable

IMoniker

IRunningObjectTable