IOleClientSite::ShowObject

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method prompts a container to display an object.

Syntax

HRESULT ShowObject(); 

Parameters

None.

Return Value

If the container has tried to make the object visible, the return value is S_OK.

If the client site is in an OLE 1 container, the return value is OLE_E_NOT_SUPPORTED.

Remarks

After a link client binds to a link source, it commonly calls IOleObject::DoVerb on the link source, usually requesting the source to perform some action requiring that it display itself to the user.

As part of its implementation of DoVerb, the link source can call ShowObject, which forces the client to show the link source as best it can.

If the link source's container is itself an embedded object, it recursively invokes ShowObject on its own container.

Having called the ShowObject method, a link source has no guarantee of being appropriately displayed because its container might not be able to do so at the time of the call. The ShowObject method does not guarantee visibility, only that the container will do the best it can.

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

Requirements

See Also

Reference

IOleClientSite
IOleObject::DoVerb

Concepts

Determining Supported COM APIs