Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
4/8/2010

This function supplies a pointer to the IRunningObjectTableinterface on the local Running Object Table (ROT).

Syntax 

WINOLEAPI GetRunningObjectTable(
  DWORD 
reserved,
  LPRUNNINGOBJECTTABLE* 
pprot
);

Parameters

reserved

[in] Reserved for future use; must be zero.

pprot

[out] Address of IRunningObjectTable* pointer variable that receives the interface pointer to the local ROT. When the function is successful, the caller is responsible for calling IUnknown::Releaseon the interface pointer. If an error occurs, * pprotis undefined.

Return Value

This function supports the standard return value E_UNEXPECTED, as well as the following:

S_OK

An IRunningObjectTablepointer was successfully returned.

Remarks

Each workstation has a local ROT that maintains a table of the objects that have been registered as running on that machine. This function returns an IRunningObjectTableinterface 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 for the following:

  • To register objects when they begin running

  • To record the times that those objects are modified

  • To revoke their registrations when they stop running

See the IRunningObjectTableinterface 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.

To determine whether the platform supports this function, see Determining Supported COM APIs.

Requirements

Header objbase.h
Library ole32.lib
Windows Embedded CE Windows CE 3.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also