Método IOleDocumentView::SetInPlaceSite (docobj.h)

Associa o site de exibição de documento de um contêiner ao objeto de exibição de um documento.

Sintaxe

HRESULT SetInPlaceSite(
  [in] IOleInPlaceSite *pIPSite
);

Parâmetros

[in] pIPSite

Um ponteiro para a interface IOleInPlaceSite do site de exibição de documento. Esse parâmetro pode ser NULL, caso em que o objeto de exibição de documento perde toda a asociação com o contêiner.

Retornar valor

Esse método retornará S_OK se um site de exibição de documento tiver sido associado com êxito (ou desassociado se pIPSite for NULL) com um objeto de exibição de documento. Outros valores retornados possíveis incluem o seguinte.

Código de retorno Descrição
E_FAIL
Falha na operação.

Comentários

Como parte da ativação de um objeto de documento, um contêiner deve passar ao objeto um ponteiro para a implementação do contêiner de IOleInPlaceSite. Esse ponteiro designa o site de exibição de documento que deve ser associado à exibição na qual esse método é chamado.

Um contêiner normalmente passa esse ponteiro em resposta à solicitação de um documento a ser ativado. Um documento faz essa solicitação chamando IOleDocumentSite::ActivateMe e passando o contêiner um ponteiro para o modo de exibição a ser ativado. O contêiner, por sua vez, usa esse ponteiro para chamar IOleDocumentView::SetInPlaceSite.

Anotações aos Chamadores

Se o contêiner estiver solicitando a criação e a ativação de uma nova instância de um objeto de documento, em vez de apenas a ativação de uma instância carregada de um objeto de documento, o site de exibição será passado no argumento pIPSite de IOleDocument::CreateView. Portanto, uma chamada explícita para IOleDocumentView::SetInPlaceSite é desnecessária.

Observações aos implementadores

Se esse método for chamado em um modo de exibição que já esteja associado a um site de exibição, o modo de exibição deverá fazer alguma limpeza na preparação para se ativar no novo site. Primeiro, o modo de exibição deve se desativar no site atual e liberar seu ponteiro para esse site. Em seguida, se o novo ponteiro IOleInPlaceSite não for NULL, o modo de exibição deverá salvar o ponteiro e chamar IUnknown::AddRef nele. Em seguida, o modo de exibição deve aguardar até que o contêiner informe quando se ativar no novo site de exibição.

Uma exibição de documento deve implementar esse método completamente; E_NOTIMPL não é um valor retornado aceitável.

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 docobj.h

Confira também

Ioledocumentview

IOleDocumentView::SetInPlaceSite