Metodo IOleObject::SetClientSite (oleidl.h)

Articolo
03/08/2023

Informa un oggetto incorporato del relativo percorso di visualizzazione, denominato "sito client", all'interno del relativo contenitore.

Sintassi

HRESULT SetClientSite(
  [in] IOleClientSite *pClientSite
);

Parametri

[in] pClientSite

Puntatore all'interfaccia IOleClientSite nel sito client dell'applicazione contenitore.

Valore restituito

Questo metodo restituisce S_OK se l'operazione ha esito positivo. Gli altri valori restituiti possibili includono i seguenti:

Codice restituito	Descrizione
E_UNEXPECTED	Si è verificato un errore imprevisto.

Commenti

All'interno di un documento composto, ogni oggetto incorporato ha un proprio sito client, ovvero il luogo in cui viene visualizzato e tramite il quale riceve informazioni sull'archiviazione, sull'interfaccia utente e su altre risorse. IOleObject::SetClientSite è l'unico metodo che consente a un oggetto incorporato di ottenere un puntatore al relativo sito client.

Note ai chiamanti

Un contenitore può notificare a un oggetto il relativo sito client al momento della creazione dell'oggetto o, successivamente, quando l'oggetto viene inizializzato.

Durante la creazione o il caricamento di un oggetto, un contenitore può passare un puntatore del sito client (insieme ad altri argomenti) a una delle funzioni helper seguenti: OleCreate,OleCreateFromFile, OleCreateFromData o OleLoad. Queste funzioni helper caricano un gestore oggetti per il nuovo oggetto e chiamano IOleObject::SetClientSite per conto del contenitore prima di restituire un puntatore al nuovo oggetto.

Il passaggio di un puntatore del sito client informa il gestore dell'oggetto che il sito client è pronto per elaborare le richieste. Se è improbabile che il sito client sia pronto immediatamente dopo il caricamento del gestore, è possibile che il contenitore passi un puntatore del sito client NULL alla funzione helper. Il puntatore NULL indica che nessun sito client è disponibile e pertanto rinvia la notifica al gestore dell'oggetto del sito client fino all'inizializzazione dell'oggetto. In risposta, la funzione helper restituisce un puntatore all'oggetto , ma quando riceve tale puntatore il contenitore deve chiamare IOleObject::SetClientSite come parte dell'inizializzazione del nuovo oggetto.

Note per gli implementatori

L'implementazione consiste semplicemente nell'incrementare il conteggio dei riferimenti e archiviare il puntatore al sito client.

Requisiti

Requisito	Valore
Client minimo supportato	Windows 2000 Professional [solo app desktop]
Server minimo supportato	Windows 2000 Server [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	oleidl.h