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 determines whether a compound document object is currently in the running state.

Syntax 

BOOL OleIsRunning(
  LPOLEOBJECT 
pObject
);

Parameters

pObject

[in] Pointer to the IOleObjectinterface on the object of interest.

Return Value

This function returns TRUE if the object is running; otherwise, the function returns FALSE.

Remarks

Passing invalid (and under some circumstances NULL) pointers into this function causes an unexpected termination of the application.

You can use OleIsRunningand IRunnableObject::IsRunninginterchangeably.

OleIsRunningqueries the object for a pointer to the IRunnableObjectinterface and calls its IsRunningmethod. If successful, the function returns the results of the call to IRunnableObject::IsRunning.

The implementation of OleIsRunningin earlier versions of OLE differs from that described here.

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

Requirements

Header ole2.h
Library ole32.lib
Windows Embedded CE Windows CE 2.0 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also