IRunnableObject::IsRunning

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method determines whether an object is currently in the running state.

Syntax

BOOL IsRunning();

Parameters

None.

Return Value

• TRUE
  The object is in the running state.

• FALSE
  The object is not in the running state.

Remarks

A container application could call IRunnableObject::IsRunning when it needs to know if the server is immediately available.

For example, a container's implementation of the IOleItemContainer::GetObject method would return an error if the server is not running and the bindspeed parameter specifies BINDSPEED_IMMEDIATE.

An object handler could call IRunnableObject::IsRunning when it wants to avoid conflicts with a running server or when the running server might have more up-to-date information.

For example, a handler's implementation of IOleObject::GetExtent would delegate to the object server if it is running, because the server's information might be more current than that in the handler's cache.

OleIsRunning is a helper function that conveniently repackages the functionality offered by IRunnableObject::IsRunning.

With the release of OLE 2.01, the implementation of OleIsRunning was changed so that it calls QueryInterface, asks for IRunnableObject, and then calls IRunnableObject::IsRunning. In other words, you can use the interface and the helper function interchangeably.

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

Requirements

See Also

Reference

OleIsRunning