OleIsRunning

A version of this page is also available for

Windows Embedded CE 6.0 R3

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 IOleObject interface 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 OleIsRunning and IRunnableObject::IsRunning interchangeably.

OleIsRunning queries the object for a pointer to the IRunnableObject interface and calls its IsRunning method. If successful, the function returns the results of the call to IRunnableObject::IsRunning.

The implementation of OleIsRunning in 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

Reference

Automation Functions
IOleObject
IRunnableObject::IsRunning
IRunnableObject

Concepts

Determining Supported COM APIs