IOleObject::SetClientSite-Methode (oleidl.h)

Artikel
03/01/2024

Informiert ein eingebettetes Objekt über seine Anzeigeposition, die als "Clientstandort" bezeichnet wird, innerhalb des Containers.

Syntax

HRESULT SetClientSite(
  [in] IOleClientSite *pClientSite
);

Parameter

[in] pClientSite

Zeiger auf die IOleClientSite-Schnittstelle am Client-Standort der Containeranwendung.

Rückgabewert

Diese Methode gibt S_OK bei Erfolg zurück. Weitere mögliche Rückgabewerte:

Rückgabecode	Beschreibung
E_UNEXPECTED	Ein unerwarteter Fehler ist aufgetreten.

Hinweise

In einem zusammengesetzten Dokument verfügt jedes eingebettete Objekt über einen eigenen Clientstandort – den Ort, an dem es angezeigt wird und über den es Informationen über seinen Speicher, seine Benutzeroberfläche und andere Ressourcen empfängt. IOleObject::SetClientSite ist die einzige Methode, mit der ein eingebettetes Objekt einen Zeiger auf seinen Clientstandort abrufen kann.

Hinweise für Anrufer

Ein Container kann ein Objekt seines Clientstandorts entweder zum Zeitpunkt der Erstellung des Objekts oder später bei der Initialisierung des Objekts benachrichtigen.

Beim Erstellen oder Laden eines Objekts kann ein Container einen Client-Standortzeiger (zusammen mit anderen Argumenten) an eine der folgenden Hilfsfunktionen übergeben: OleCreate, OleCreateFromFile, OleCreateFromData oder OleLoad. Diese Hilfsfunktionen laden einen Objekthandler für das neue Objekt und rufen IOleObject::SetClientSite im Namen des Containers auf, bevor ein Zeiger auf das neue Objekt zurückgegeben wird.

Durch Das Übergeben eines Clientstandortzeigers wird der Objekthandler darüber informiert, dass der Clientstandort bereit ist, Anforderungen zu verarbeiten. Wenn der Clientstandort wahrscheinlich nicht unmittelbar nach dem Laden des Handlers bereit ist, sollten Sie einen NULL-Clientstandortzeiger an die Hilfsfunktion übergeben. Der NULL-Zeiger sagt, dass kein Clientstandort verfügbar ist, und verschiebt daher die Benachrichtigung des Objekthandlers des Clientstandorts, bis das Objekt initialisiert wird. Als Antwort gibt die Hilfsfunktion einen Zeiger auf das -Objekt zurück, aber beim Empfangen dieses Zeigers muss der Container IOleObject::SetClientSite aufrufen, um das neue Objekt zu initialisieren.

Hinweise zu Implementierern

Die Implementierung besteht einfach darin, die Referenzanzahl auf dem Clientstandort zu erhöhen und den Zeiger auf den Clientstandort zu speichern.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	oleidl.h