Méthode IOleLink ::GetSourceDisplayName (oleidl.h)

Article
03/13/2024

Récupère le nom d’affichage de la source de lien de l’objet lié.

Syntaxe

HRESULT GetSourceDisplayName(
  [out] LPOLESTR *ppszDisplayName
);

Paramètres

[out] ppszDisplayName

Adresse d’une variable pointeur qui reçoit un pointeur vers le nom d’affichage de la source de lien. Si une erreur se produit, ppszDisplayName est défini sur NULL ; sinon, l’implémentation doit utiliser IMalloc ::Alloc pour allouer la chaîne retournée dans ppszDisplayName, et l’appelant est responsable de l’appel de IMalloc ::Free pour la libérer. L’appelant et l’appelé utilisent l’allocateur retourné par CoGetMalloc.

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_FAIL	L'opération a échoué.

La récupération du nom d’affichage nécessite l’appel de ces fonctions ; Par conséquent, cette méthode peut retourner des erreurs générées par CreateBindCtx et IMoniker ::GetDisplayName.

Remarques

Notes aux appelants

Votre application conteneur peut appeler IOleLink ::GetSourceDisplayName pour afficher la source actuelle d’un lien.

La source actuelle d’un lien s’affiche dans la boîte de dialogue Liens . Si vous utilisez la fonction OleUIEditLinks pour afficher la boîte de dialogue Liens , vous devez implémenter l’interface IOleUILinkContainer . La boîte de dialogue appelle vos implémentations de IOleUILinkContainer ::GetLinkSource pour obtenir la chaîne qu’elle doit afficher. Votre implémentation de cette méthode peut appeler IOleLink ::GetSourceDisplayName.

Notes aux implémenteurs

L’implémentation de IOleLink ::GetSourceDisplayName par l’objet lié appelle IOleLink ::GetSourceMoniker pour obtenir le moniker source de lien, puis appelle IMoniker ::GetDisplayName pour obtenir le nom d’affichage de ce moniker. Cette opération est potentiellement coûteuse, car elle peut nécessiter la liaison du moniker. Tous les monikers fournis par le système peuvent retourner un nom d’affichage sans liaison, mais il n’y a aucune garantie que d’autres implémentations de moniker le puissent. Au lieu d’effectuer des appels répétés à IOleLink ::GetSourceDisplayName, votre application conteneur peut mettre en cache le nom et le mettre à jour chaque fois que la source de lien est liée.

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