IOleObject ::GetClientSite, méthode (oleidl.h)
Récupère un pointeur vers le site client d’un objet incorporé.
Syntaxe
HRESULT GetClientSite(
[out] IOleClientSite **ppClientSite
);
Paramètres
[out] ppClientSite
Adresse de la variable pointeur IOleClientSite qui reçoit le pointeur d’interface vers le site client de l’objet. Si un objet ne connaît pas encore son site client, ou si une erreur s’est produite, ppClientSite doit être défini sur NULL. Chaque fois qu’un objet reçoit un appel à IOleObject ::GetClientSite, il doit augmenter le nombre de références sur ppClientSite. Il est de la responsabilité de l’appelant d’appeler Release quand il a terminé avec ppClientSite.
Valeur retournée
Cette méthode retourne S_OK en cas de réussite.
Remarques
Les clients de liaison appellent généralement la méthode IOleObject ::GetClientSite conjointement avec la méthode IOleClientSite ::GetContainer pour parcourir une hiérarchie d’objets imbriqués. Un client de liaison appelle IOleObject ::GetClientSite pour obtenir un pointeur vers le site client de la source de lien. Le client appelle ensuite IOleClientSite ::GetContainer pour obtenir un pointeur vers le conteneur de la source de lien. Enfin, le client appelle QueryInterface pour obtenir IOleObject et IOleObject ::GetClientSite afin d’obtenir le site client du conteneur dans son conteneur. En répétant cette séquence d’appels, l’appelant peut récupérer un pointeur vers le conteneur master dans lequel tous les autres objets sont imbriqués.
Remarques aux appelants
Le pointeur client-site retourné est NULL si un objet incorporé n’a pas encore été informé de son site client. Ce sera le cas avec un objet nouvellement chargé ou créé lorsqu’un conteneur a transmis un pointeur client-site NULL à l’une des fonctions d’assistance à la création d’objets, mais qu’il n’a pas encore appelé IOleObject ::SetClientSite dans le cadre de l’initialisation de l’objet.Configuration requise
| Condition requise | Valeur |
|---|---|
| Client minimal pris en charge | Windows 2000 Professionnel [applications de bureau uniquement] |
| Serveur minimal pris en charge | Windows 2000 Server [applications de bureau uniquement] |
| Plateforme cible | Windows |
| En-tête | oleidl.h |