Метод IOleLink::GetSourceDisplayName (oleidl.h)
Извлекает отображаемое имя источника ссылки связанного объекта.
Синтаксис
HRESULT GetSourceDisplayName(
[out] LPOLESTR *ppszDisplayName
);
Параметры
[out] ppszDisplayName
Адрес переменной указателя, получающей указатель на отображаемое имя источника ссылки. При возникновении ошибки параметру ppszDisplayName присваивается значение NULL; В противном случае реализация должна использовать IMalloc::Alloc для выделения строки, возвращаемой в ppszDisplayName, а вызывающий объект отвечает за вызов IMalloc::Free для ее освобождения. Как вызывающий, так и вызываемый используют распределитель, возвращенный CoGetMalloc.
Возвращаемое значение
Этот метод возвращает значение S_OK при успешном завершении. Другие возможные возвращаемые значения включают следующее.
| Код возврата | Описание |
|---|---|
|
Операция не удалась. |
Для получения отображаемого имени требуется вызов этих функций; Поэтому этот метод может возвращать ошибки, созданные CreateBindCtx и IMoniker::GetDisplayName.
Комментарии
Примечания к вызывающим абонентам
Приложение-контейнер может вызывать IOleLink::GetSourceDisplayName для отображения текущего источника ссылки.Текущий источник ссылки отображается в диалоговом окне Ссылки . Если для отображения диалогового окна Ссылки используется функция OleUIEditLinks, необходимо реализовать интерфейс IOleUILinkContainer. Диалоговое окно вызывает реализации IOleUILinkContainer::GetLinkSource , чтобы получить строку, которую он должен отобразить. Реализация этого метода может вызывать IOleLink::GetSourceDisplayName.
Примечания для разработчиков
Реализация IOleLink::GetSourceDisplayName связанного объекта вызывает IOleLink::GetSourceMoniker для получения исходного моникера ссылки, а затем вызывает IMoniker::GetDisplayName , чтобы получить отображаемое имя этого моникера. Эта операция потенциально затратна, так как для нее может потребоваться привязка моникера. Все предоставляемые системой моникеры могут возвращать отображаемое имя без привязки, но нет никакой гарантии, что другие реализации моникера могут это сделать. Вместо повторных вызовов IOleLink::GetSourceDisplayName приложение контейнера может кэшировать имя и обновлять его при привязке источника ссылки.Требования
| Требование | Значение |
|---|---|
| Минимальная версия клиента | Windows 2000 Professional [только классические приложения] |
| Минимальная версия сервера | Windows 2000 Server [только классические приложения] |
| Целевая платформа | Windows |
| Header | oleidl.h |