IOleObject::SetClientSite
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
9/8/2008
Thismethod informa um objeto incorporado de sua localidade exibir, chamado um "site cliente", No seu contêiner.
Syntax
HRESULT SetClientSite(
IOleClientSite* pClientSite
);
Parameters
- pClientSite
[no] Ponteiro para o IOleClientSite interface no cliente do aplicativo contêiner-site.
Return Value
Este método oferece suporte a padrão valor de retorno E_UNEXPECTED, as well as S_OK, que indica que o site cliente definidas com êxito.
Remarks
Em um documento composto, cada objeto incorporado tem seu próprio site cliente, qual é o local onde ele é exibido e através do qual ele recebe informações sobre seu armazenamento, interface usuário e outros recursos.
SetClientSite o método somente está ativando um objeto incorporado para obter um ponteiro para seu site cliente.
Para determinar se a plataforma oferece suporte a esta interface, consulte Determinando suporte COM APIs.
Notas para chamadores
Um contêiner pode notificar um objeto do seu site cliente no tempo de objeto é criado ou quando o objeto é inicializado.
Ao criar ou carregar um objeto, um contêiner pode transmitir uma cliente-ponteiro site (along with outros parâmetros) para OleCreate, uma função auxiliar. Essa função auxiliar carrega um manipulador objeto para o novo objeto e chamadas SetClientSite Em Nome do contêiner antes de retornar um ponteiro para o novo objeto.
Passando uma cliente-ponteiro site informa o manipulador objeto que o site cliente está pronto para solicitações processo.
Se o site cliente é improvável que esteja pronto imediatamente depois que o manipulador é carregado, você pode desejar seu contêiner para transmitir um NULL cliente-site ponteiro para a função auxiliar.
O NULL ponteiro diz que nenhum site cliente está disponível e adia notificando o manipulador objeto do site de cliente até o objeto é inicializado.
Em resposta, a função auxiliar retorna um ponteiro para o objeto, mas ao receber esse ponteiro o contêiner deve chamar SetClientSite Como parte de inicializar o novo objeto.
Notas para Implementers
A implementação consiste em simplesmente de incrementar o contagem de referência no e armazenar, o ponteiro para o site cliente.
Requirements
| Header | Oleidl.h, oleidl.idl |
| Library | oleaut32.lib, uuid.lib |
| Windows Embedded CE | Windows CE 2.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |
See Also
Reference
IOleObject
IOleClientSite
OleCreate