IOleUILinkContainerA ::GetLinkSource, méthode (oledlg.h)

Article
03/04/2024

Récupère des informations sur un lien qui peuvent être affichées dans la boîte de dialogue Liens .

Syntaxe

HRESULT GetLinkSource(
  [in]            DWORD dwLink,
  [out, optional] LPSTR *lplpszDisplayName,
  [out]           ULONG *lplenFileName,
  [out, optional] LPSTR *lplpszFullLinkType,
  [out, optional] LPSTR *lplpszShortLinkType,
  [out]           BOOL  *lpfSourceAvailable,
  [out]           BOOL  *lpfIsSelected
);

Paramètres

[in] dwLink

Identificateur unique défini par le conteneur pour un lien unique. Consultez IOleUILinkContainer ::GetNextLink.

[out, optional] lplpszDisplayName

Adresse d’une variable pointeur qui reçoit un pointeur vers la chaîne de nom d’affichage complète de la source du lien. La boîte de dialogue Liens libère cette chaîne.

[out] lplenFileName

Pointeur vers la longueur de la partie du nom de fichier de début de la chaîne lplpszDisplayName . Si la source du lien n’est pas stockée dans un fichier, lplenFileName doit avoir la valeur 0. Pour les liens OLE, appelez IOleLink ::GetSourceDisplayName.

[out, optional] lplpszFullLinkType

Adresse d’une variable pointeur qui reçoit un pointeur vers la chaîne de type de lien complète affichée en bas de la boîte de dialogue Liens . L’appelant alloue cette chaîne. La boîte de dialogue Liens libère cette chaîne. Pour les liens OLE, il doit s’agir du nom complet du type d’utilisateur. Utilisez IOleObject ::GetUserType, en spécifiant USERCLASSTYPE_FULL pour dwFormOfType.

[out, optional] lplpszShortLinkType

Adresse d’une variable pointeur qui reçoit un pointeur vers la chaîne de type de lien court affichée dans la zone de liste de la boîte de dialogue Liens . L’appelant alloue cette chaîne. La boîte de dialogue Liens libère cette chaîne. Pour les liens OLE, il doit s’agir du nom de type d’utilisateur court. Utilisez IOleObject ::GetUserType, en spécifiant USERCLASSTYPE_SHORT pour dwFormOfType.

[out] lpfSourceAvailable

Pointeur qui retourne FALSE s’il est connu qu’un lien n’est pas disponible, car le lien est vers un document connu mais non disponible. Certaines options, telles que Mettre à jour maintenant, sont désactivées (grisées dans l’interface utilisateur) pour de tels cas.

[out] lpfIsSelected

Pointeur vers une variable qui indique à la boîte de dialogue Modifier les liens que l’entrée de ce lien doit être sélectionnée dans la zone de liste à sélection multiple de la boîte de dialogue. OleUIEditLinks appelle cette méthode au moins une fois pour chaque élément à placer dans la liste des liens. Si aucun d’entre eux ne retourne TRUE, aucun d’entre eux n’est sélectionné lorsque la boîte de dialogue est affichée pour la première fois. Si tous retournent TRUE, tout s’affiche. Autrement dit, elle retourne TRUE si ce lien fait actuellement partie de la sélection dans le document sous-jacent, FALSE si ce n’est pas le cas. Tous les liens sélectionnés dans le document sous-jacent sont sélectionnés dans la boîte de dialogue ; De cette façon, l’utilisateur peut sélectionner un ensemble de liens et utiliser la boîte de dialogue pour les mettre à jour ou modifier sa ou ses sources simultanément.

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_ACCESSDENIED	Autorisations d’accès insuffisantes.
E_FAIL	L'opération a échoué.
E_INVALIDARG	L’identificateur spécifié n’est pas valide.
E_OUTOFMEMORY	La mémoire disponible est insuffisante pour cette opération.

Remarques

Remarques aux appelants

Appelez cette méthode lors de l’initialisation de la boîte de dialogue, après être retourné à partir de la boîte de dialogue Modifier la source .

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	oledlg.h