Partager via

Méthode IOleClientSite ::GetContainer (oleidl.h)

  • Article

Récupère un pointeur vers le conteneur de l’objet.

Syntaxe

HRESULT GetContainer(
  [out] IOleContainer **ppContainer
);

Paramètres

[out] ppContainer

Adresse de la variable de pointeur IOleContainer qui reçoit le pointeur d’interface vers l’objet conteneur. Si une erreur se produit, l’implémentation doit définir ppContainer sur NULL.

Valeur retournée

Cette méthode retourne S_OK en cas de réussite. Les autres valeurs de retour possibles sont les suivantes.

Code de retour Description
OLE_E_NOT_SUPPORTED
 Le site client se trouve dans un conteneur OLE 1.
E_NOINTERFACE
 Le conteneur n’implémente pas l’interface IOleContainer .

Remarques

Si un conteneur prend en charge les liens vers ses objets incorporés, l’implémentation de GetContainer permet aux clients de liaison d’énumérer les objets du conteneur et de parcourir de manière récursive une hiérarchie de confinement. Cette méthode est facultative, mais recommandée pour tous les conteneurs qui s’attendent à prendre en charge les liens vers leurs objets incorporés.

Les clients de liaison peuvent parcourir une hiérarchie d’objets de document composés en appelant de manière récursive GetContainer pour obtenir un pointeur vers le conteneur de la source de lien ; suivi de QueryInterface pour obtenir un pointeur vers l’interface IOleObject du conteneur et, enfin, IOleObject ::GetClientSite pour obtenir le site client du conteneur dans son conteneur.

Les conteneurs simples qui ne prennent pas en charge les liens vers leurs objets incorporés n’ont probablement pas besoin d’implémenter cette méthode. Au lieu de cela, ils peuvent retourner E_NOINTERFACE et définir ppContainer sur NULL.

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

Voir aussi

IOleClientSite