This method requests a pointer to an object’s container.
At a Glance
| Header file: | Oleidl.h |
| Windows CE versions: | 2.0 and later |
Syntax
HRESEUT GetContainer( LPOLECONTAINTER FAR * ppContainer);
Parameters
ppContainer
[out] Address of IOleContainer* pointer variable that receives the interface pointer to the container object. If an error occurs, the implementation must set *ppContainer to NULL.
Return Values
One of the values described in the following table is returned.
| Value | Description |
| S_OK | The pointer to the container’s IOleContainer interface was successfully returned. |
| OLE_E_NOT_SUPPORTED | Client site is in OLE 1 container. |
| E_NOINTERFACE | The container does not implement the IOleContainer interface. |
Remarks
If a container supports links to its embedded objects, implementing IOleClientSite::GetContainer enables link clients to enumerate the container’s objects and recursively traverse a containment hierarchy. This method is optional but recommended for all containers that expect to support links to their embedded objects.
Link clients can traverse a hierarchy of compound-document objects by recursively calling IOleClientSite::GetContainer to get a pointer to the link source’s container; followed by IOleContainer::QueryInterface to get a pointer to the container’s IOleObject interface and, finally, IOleObject::GetClientSite to get the container’s client site in its container.
Simple containers that do not support links to their embedded objects probably do not need to implement this method. Instead, they can return E_NOINTERFACE and set ppContainer to NULL.