IRunnableObject::SetContainedObject

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method notifies an object that it is embedded in an OLE container, which ensures that reference counting is done correctly for containers that support links to embedded objects.

Syntax

HRESULT SetContainedObject(
  BOOL fContained 
);

Parameters

• fContained
  [in] TRUE specifies that the object is contained in an OLE container. FALSE indicates that it is not.

Return Value

This method supports the standard return values E_INVALIDARG, E_OUTOFMEMORY AND E_UNEXPECTED, as well as the following:

• S_OK
  Object has been marked as a contained embedding.

Remarks

The IRunnableObject::SetContainedObject method enables a container to inform an object handler that it is embedded in the container, rather than acting as a link. This call changes the container's reference on the object from strong, the default for external connections, to weak.

When the object is running visibly, this method is of little significance because the user has a lock on the object. During a silent update of an embedded link source, however, the container should not be able to hold an object in the running state after the link has been broken. For this reason, the container's reference to the object must be weak.

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

Notes to Callers

A container application must call IRunnableObject::SetContainedObject if it supports linking to embedded objects.

It typically makes the call immediately after calling OleCreate and never calls the method again, even before it closes. Moreover, a container almost always calls this method with fContained set to TRUE. The use of this method with fContained set to FALSE is rare.

Calling IRunnableObject::SetContainedObject is optional only when you know that the embedded object will not be referenced by any client other than the container.

If your container application does not support linking to embedded objects; it is preferable, but not necessary, to call IRunnableObject::SetContainedObject.

OleSetContainedObject is a helper function that conveniently repackages the functionality offered by IRunnableObject::SetContainedObject.

With the release of OLE 2.01, the implementation of OleSetContainedObject was changed to call QueryInterface, ask for IRunnableObject, and then call IRunnableObject::SetContainedObject. In other words, you can use the interface and the helper function interchangeably.

Requirements

See Also

Reference

OleSetContainedObject
CoLockObjectExternal