Поделиться через


Метод ISyncMgrEvent::GetLinkText (syncmgr.h)

Возвращает текст для горячей ссылки для события. Горячая ссылка — это отображаемое свойство, которое пользователь может щелкнуть для выполнения действия. Это позволяет обработчику отображать доступное действие, которое пользователь может увидеть в папке. Текст ссылки — это текст, отображаемый пользователю.

Синтаксис

HRESULT GetLinkText(
  [out] LPWSTR *ppszLinkText
);

Параметры

[out] ppszLinkText

Тип: LPWSTR*

При возврате этого метода содержит указатель на текст ссылки в виде строки Юникода.

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

Тип: HRESULT

Если этот метод завершается успешно, он возвращает S_OK. В противном случае возвращается код ошибки HRESULT .

Комментарии

Ожидается, что событие выделит буфер строк с помощью CoTaskMemAlloc, который центр синхронизации использует для освобождения буфера строк.

Требования

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