This method prompts a container to display an object.
At a Glance
Header file: | Oleidl.h |
Windows CE versions: | 2.0 and later |
Syntax
HRESULT ShowObject();
Return Values
One of the values described in the following table is returned.
Value | Description |
S_OK | Container has tried to make the object visible. |
OLE_E_NOT_SUPPORTED | Client site is in an OLE 1 container. |
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 IOleClientSite::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 will recursively invoke IOleClientSite::ShowObject on its own container.
Having called the ShowObject method, a link source has no guarantee of being appropriately displayed because its container may 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.