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

Artículo
08/25/2023

Recupera el nombre para mostrar del origen del vínculo del objeto vinculado.

Sintaxis

HRESULT GetSourceDisplayName(
  [out] LPOLESTR *ppszDisplayName
);

Parámetros

[out] ppszDisplayName

Dirección de una variable de puntero que recibe un puntero al nombre para mostrar del origen del vínculo. Si se produce un error, ppszDisplayName se establece en NULL; De lo contrario, la implementación debe usar IMalloc::Alloc para asignar la cadena devuelta en ppszDisplayName y el autor de la llamada es responsable de llamar a IMalloc::Free para liberarla. Tanto el llamador como el llamador usan el asignador devuelto por CoGetMalloc.

Valor devuelto

Este método devuelve S_OK cuando funciona correctamente. Otros posibles valores devueltos son los siguientes.

Código devuelto	Descripción
E_FAIL	Error en la operación.

Recuperar el nombre para mostrar requiere llamar a estas funciones; por lo tanto, este método puede devolver errores generados por CreateBindCtx e IMoniker::GetDisplayName.

Comentarios

Notas a los autores de llamadas

La aplicación contenedora puede llamar a IOleLink::GetSourceDisplayName para mostrar el origen actual de un vínculo.

El origen actual de un vínculo se muestra en el cuadro de diálogo Vínculos . Si usa la función OleUIEditLinks para mostrar el cuadro de diálogo Vínculos , debe implementar la interfaz IOleUILinkContainer . El cuadro de diálogo llama a las implementaciones de IOleUILinkContainer::GetLinkSource para obtener la cadena que debe mostrar. La implementación de ese método puede llamar a IOleLink::GetSourceDisplayName.

Notas para los implementadores

La implementación del objeto vinculado de IOleLink::GetSourceDisplayName llama a IOleLink::GetSourceMoniker para obtener el moniker de origen del vínculo y, a continuación, llama a IMoniker::GetDisplayName para obtener el nombre para mostrar del moniker. Esta operación es potencialmente costosa porque podría requerir el enlace del moniker. Todos los monikers proporcionados por el sistema pueden devolver un nombre para mostrar sin enlace, pero no hay ninguna garantía de que otras implementaciones de moniker puedan. En lugar de realizar llamadas repetidas a IOleLink::GetSourceDisplayName, la aplicación contenedora puede almacenar en caché el nombre y actualizarlo siempre que el origen del vínculo esté enlazado.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 2000 Professional [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows 2000 Server [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	oleidl.h