Метод ISyncMgrSyncItem::GetName (syncmgr.h)

Статья
03/05/2024

Возвращает отображаемое имя элемента синхронизации в пользовательском интерфейсе.

Синтаксис

HRESULT GetName(
  [out] LPWSTR *ppszName
);

Параметры

[out] ppszName

Тип: LPWSTR*

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

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

Тип: HRESULT

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

Если getName завершается сбоем или в ppszItemID возвращается пустая строка, элемент синхронизации не отображается в папке обработчика и центр синхронизации не будет пытаться синхронизировать его.

Идентификатор, полученный этим методом, доступен в пользовательском интерфейсе папки обработчика как свойство System.DisplayName (PKEY_DisplayName).

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

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

В более старых реализациях Диспетчера синхронизации эти сведения были получены с помощью структуры SYNCMGRHANDLERINFO .

Примеры

В следующем примере показана реализация этого метода.

STDMETHODIMP CMyDeviceSyncItem::GetName(__out LPWSTR *ppszName)
{
    *ppszName = NULL;
    HRESULT hr = SHCoAllocString(_pszItemName, ppszName);
    return hr;
}

Требования

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

Share via