Метод ISyncMgrSyncItemInfo::GetComment (syncmgr.h)

Возвращает строку, содержащую комментарии относительно элемента.

Синтаксис

HRESULT GetComment(
  [out] LPWSTR *ppszComment
);

Параметры

[out] ppszComment

Тип: LPWSTR*

При возврате этим методом содержит указатель на буфер, содержащий строку комментария. Эта строка имеет максимальную длину MAX_SYNCMGR_NAME включая завершающий символ NULL.

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

Тип: HRESULT

Возвращает S_OK в случае успешного выполнения или значение ошибки в противном случае. Если метод завершается ошибкой, ppszComment содержит пустую строку.

Комментарии

Эта строка может быть предоставлена элементом для отображения сводки его содержимого, например "32 контактов" или "13 песен". Строка может иметь максимальную длину MAX_SYNCMGR_NAME включая завершающий символ NULL.

Если синхронизация не выполняется, значение комментария отображается как свойство System.Sync.Comments (PKEY_Sync_Comments) в пользовательском интерфейсе папки.

Центр синхронизации вызывает этот метод при каждом вызове метода UpdateHandler .

Элемент отвечает за выделение строкового буфера, на который указывает ppszComment , через CoTaskMemAlloc. Центр синхронизации освобождает буфер строки через CoTaskMemFree.

Требования

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