Método IOleObject::GetClientSite (oleidl.h)

Recupera um ponteiro para o site cliente de um objeto inserido.

Sintaxe

HRESULT GetClientSite(
  [out] IOleClientSite **ppClientSite
);

Parâmetros

[out] ppClientSite

Endereço da variável de ponteiro IOleClientSite que recebe o ponteiro de interface para o site cliente do objeto. Se um objeto ainda não souber seu site cliente ou se ocorreu um erro, ppClientSite deverá ser definido como NULL. Sempre que um objeto recebe uma chamada para IOleObject::GetClientSite, ele deve aumentar a contagem de referência em ppClientSite. É responsabilidade do chamador chamar Release quando for feito com ppClientSite.

Retornar valor

Esse método retorna S_OK com êxito.

Comentários

Os clientes de link geralmente chamam o método IOleObject::GetClientSite em conjunto com o método IOleClientSite::GetContainer para percorrer uma hierarquia de objetos aninhados. Um cliente de link chama IOleObject::GetClientSite para obter um ponteiro para o site cliente da origem do link. Em seguida, o cliente chama IOleClientSite::GetContainer para obter um ponteiro para o contêiner da origem do link. Por fim, o cliente chama QueryInterface para obter IOleObject e IOleObject::GetClientSite para obter o site cliente do contêiner em seu contêiner. Repetindo essa sequência de chamadas, o chamador pode eventualmente recuperar um ponteiro para o contêiner master no qual todos os outros objetos estão aninhados.

Anotações para chamadores

O ponteiro cliente-site retornado será NULL se um objeto inserido ainda não tiver sido informado de seu site cliente. Esse será o caso de um objeto recém-carregado ou criado quando um contêiner tiver passado um ponteiro nulo do site do cliente para uma das funções auxiliares de criação de objeto, mas ainda não tiver chamado IOleObject::SetClientSite como parte da inicialização do objeto.

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

Ioleobject

IOleObject::SetClientSite