IOleLink::GetSourceDisplayName-Methode (oleidl.h)

Artikel
03/13/2024

Ruft den Anzeigenamen der Linkquelle des verknüpften Objekts ab.

Syntax

HRESULT GetSourceDisplayName(
  [out] LPOLESTR *ppszDisplayName
);

Parameter

[out] ppszDisplayName

Adresse einer Zeigervariable, die einen Zeiger auf den Anzeigenamen der Linkquelle empfängt. Wenn ein Fehler auftritt, wird ppszDisplayName auf NULL festgelegt. Andernfalls muss die Implementierung IMalloc::Alloc verwenden, um die in ppszDisplayName zurückgegebene Zeichenfolge zuzuordnen, und der Aufrufer ist für den Aufruf von IMalloc::Free verantwortlich, um sie freizugeben. Sowohl aufrufer als auch aufgerufen verwenden die von CoGetMalloc zurückgegebene Zuweisung.

Rückgabewert

Diese Methode gibt S_OK bei Erfolg zurück. Weitere mögliche Rückgabewerte:

Rückgabecode	Beschreibung
E_FAIL	Fehler beim Vorgang.

Zum Abrufen des Anzeigenamens müssen diese Funktionen aufgerufen werden. Daher gibt diese Methode möglicherweise Fehler zurück, die von CreateBindCtx und IMoniker::GetDisplayName generiert wurden.

Hinweise

Hinweise für Anrufer

Ihre Containeranwendung kann IOleLink::GetSourceDisplayName aufrufen, um die aktuelle Quelle eines Links anzuzeigen.

Die aktuelle Quelle eines Links wird im Dialogfeld Links angezeigt. Wenn Sie die OleUIEditLinks-Funktion verwenden, um das Dialogfeld Links anzuzeigen, müssen Sie die IOleUILinkContainer-Schnittstelle implementieren. Das Dialogfeld ruft Ihre Implementierungen von IOleUILinkContainer::GetLinkSource auf, um die anzuzeigende Zeichenfolge abzurufen. Ihre Implementierung dieser Methode kann IOleLink::GetSourceDisplayName aufrufen.

Hinweise für Implementierer

Die Implementierung von IOleLink::GetSourceDisplayName des verknüpften Objekts ruft IOleLink::GetSourceMoniker auf, um den Linkquellmoniker abzurufen, und ruft dann IMoniker::GetDisplayName auf, um den Anzeigenamen dieses Monikers abzurufen. Dieser Vorgang ist potenziell teuer, da er möglicherweise die Bindung des Monikers erfordert. Alle vom System bereitgestellten Moniker können einen Anzeigenamen ohne Bindung zurückgeben, aber es gibt keine Garantie, dass andere Monikerimplementierungen dies können. Anstatt IOleLink::GetSourceDisplayName wiederholt zu aufrufen, kann Ihre Containeranwendung den Namen zwischenspeichern und aktualisieren, wenn die Linkquelle gebunden ist.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	oleidl.h