IOleInPlaceUIWindow ::SetActiveObject, méthode (oleidl.h)

Fournit un canal de communication direct entre l’objet et chacune des fenêtres frame et document.

Syntaxe

HRESULT SetActiveObject(
  [in] IOleInPlaceActiveObject *pActiveObject,
  [in] LPCOLESTR               pszObjName
);

Paramètres

[in] pActiveObject

Pointeur vers l’interface IOleInPlaceActiveObject sur l’objet actif sur place.

[in] pszObjName

Pointeur vers une chaîne contenant un nom qui décrit l’objet qu’un conteneur d’incorporation peut utiliser pour composer son titre de fenêtre. Elle peut être NULL si l’objet ne nécessite pas que le conteneur modifie ses titres de fenêtre. Les conteneurs doivent ignorer ce paramètre et utiliser toujours leur propre nom dans la barre de titre.

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
E_UNEXPECTED
Une erreur inattendue s’est produite.

Remarques

En règle générale, un objet incorporé doit passer la valeur NULL pour le paramètre pszObjName (voir Notes aux implémenteurs ci-dessous). Toutefois, si vous travaillez conjointement avec un conteneur qui affiche le nom de l’objet actif sur place dans sa barre de titre, vous devez composer une chaîne sous la forme suivante : < nom > de l’application – <nom> de type court de l’objet.

Notes aux appelants

IOleInPlaceUIWindow ::SetActiveObject est appelé par l’objet pour établir un lien de communication directe entre lui-même et les fenêtres de document et de cadre.

Lors de la désactivation, l’objet appelle IOleInPlaceUIWindow ::SetActiveObject, en passant NULL pour les paramètres pActiveObject et pszObjName.

Un objet doit appeler IOleInPlaceUIWindow ::SetActiveObject avant d’appeler IOleInPlaceFrame ::SetMenu pour donner au conteneur le pointeur vers l’objet actif. Le conteneur utilise ensuite ce pointeur pour traiter IOleInPlaceFrame ::SetMenu et passer à OleSetMenuDescriptor.

Notes aux implémenteurs

Le Guide de conception de l’interface utilisateur Microsoft Windows recommande qu’un conteneur sur place ignore le paramètre pszObjName passé dans cette méthode. Le guide indique : « La barre de titre n’est pas affectée par l’activation sur place. Il affiche toujours le nom du conteneur de niveau supérieur. »

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

IOleInPlaceFrame ::SetMenu

IOleInPlaceUIWindow

OleSetMenuDescriptor