Метод IOleUILinkContainerA::GetLinkSource (oledlg.h)

Статья
08/25/2023

Извлекает сведения о ссылке, которая может отображаться в диалоговом окне Ссылки .

Синтаксис

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
);

Параметры

[in] dwLink

Определяемый контейнером уникальный идентификатор для одной ссылки. См. раздел IOleUILinkContainer::GetNextLink.

[out, optional] lplpszDisplayName

Адрес переменной указателя, которая получает указатель на полную строку отображаемого имени для источника ссылки. Диалоговое окно Ссылки освободит эту строку.

[out] lplenFileName

Указатель на длину начальной части имени файла строки lplpszDisplayName . Если источник ссылки не хранится в файле, значение lplenFileName должно иметь значение 0. Для ссылок OLE вызовите IOleLink::GetSourceDisplayName.

[out, optional] lplpszFullLinkType

Адрес переменной указателя, которая получает указатель на полную строку типа ссылки, которая отображается в нижней части диалогового окна Ссылки . Вызывающий объект выделяет эту строку. Диалоговое окно Ссылки освободит эту строку. Для ссылок OLE это должно быть полное имя типа пользователя. Используйте IOleObject::GetUserType, указав USERCLASSTYPE_FULL для dwFormOfType.

[out, optional] lplpszShortLinkType

Адрес переменной указателя, получающей указатель на строку короткого типа ссылки, которая отображается в списке диалогового окна Ссылки . Вызывающий объект выделяет эту строку. Диалоговое окно Ссылки освободит эту строку. Для ссылок OLE это должно быть короткое имя типа пользователя. Используйте IOleObject::GetUserType, указав USERCLASSTYPE_SHORT для dwFormOfType.

[out] lpfSourceAvailable

Указатель, возвращающий значение FALSE , если известно, что ссылка недоступна, так как она связана с каким-то известным, но недоступным документом. В таких случаях некоторые параметры, такие как Обновить сейчас, отключены (серым цветом в пользовательском интерфейсе).

[out] lpfIsSelected

Указатель на переменную, которая сообщает диалоговому окку "Изменение ссылок ", что запись этой ссылки должна быть выбрана в списке с множественным выбором диалогового окна. OleUIEditLinks вызывает этот метод по крайней мере один раз для каждого элемента, который будет помещен в список ссылок. Если ни один из них не возвращает значение TRUE, ни один из них не будет выбран при первом отображении диалогового окна. Если все они возвращают значение TRUE, будут отображены все. То есть возвращает значение TRUE , если эта ссылка в настоящее время является частью выделенного фрагмента в базовом документе, и false , если нет. Все ссылки, выбранные в базовом документе, выбираются в диалоговом окне; Таким образом, пользователь может выбрать набор ссылок и использовать диалоговое окно для их обновления или изменения источников одновременно.

Возвращаемое значение

Этот метод возвращает значение S_OK при успешном завершении. Другие возможные возвращаемые значения включают следующее.

Код возврата	Описание
E_ACCESSDENIED	Недостаточно разрешений на доступ.
E_FAIL	Операция не удалась.
E_INVALIDARG	Указанный идентификатор недопустим.
E_OUTOFMEMORY	Недостаточно доступной памяти для этой операции.

Требования

Требование	Значение
Минимальная версия клиента	Windows 2000 Professional [только классические приложения]
Минимальная версия сервера	Windows 2000 Server [только классические приложения]
Целевая платформа	Windows
Header	oledlg.h