Método IOleClientSite::GetContainer (oleidl.h)

Recupera um ponteiro para o contêiner do objeto.

Sintaxe

HRESULT GetContainer(
  [out] IOleContainer **ppContainer
);

Parâmetros

[out] ppContainer

Endereço da variável de ponteiro IOleContainer que recebe o ponteiro de interface para o objeto de contêiner. Se ocorrer um erro, a implementação deverá definir ppContainer como NULL.

Retornar valor

Esse método retorna S_OK em caso de êxito. Outros valores retornados possíveis incluem o seguinte.

Código de retorno	Descrição
OLE_E_NOT_SUPPORTED	O site do cliente está em um contêiner OLE 1.
E_NOINTERFACE	O contêiner não implementa a interface IOleContainer .

Comentários

Se um contêiner der suporte a links para seus objetos inseridos, implementar GetContainer permitirá que os clientes de link enumerem os objetos do contêiner e percorram recursivamente uma hierarquia de contenção. Esse método é opcional, mas recomendado para todos os contêineres que esperam dar suporte a links para seus objetos inseridos.

Os clientes de link podem percorrer uma hierarquia de objetos de documento composto chamando Recursivamente GetContainer para obter um ponteiro para o contêiner da origem do link; seguido por QueryInterface para obter um ponteiro para a interface IOleObject do contêiner e, por fim, IOleObject::GetClientSite para obter o site cliente do contêiner em seu contêiner.

Contêineres simples que não dão suporte a links para seus objetos inseridos provavelmente não precisam implementar esse método. Em vez disso, eles podem retornar E_NOINTERFACE e definir ppContainer como NULL.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 2000 Professional [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows 2000 Server [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	oleidl.h

Confira também

Ioleclientsite