ISyncMgrSyncItem：：GetName 方法 (syncmgr.h)

取得同步專案的 UI 顯示名稱。

語法

HRESULT GetName(
  [out] LPWSTR *ppszName
);

參數

[out] ppszName

類型： LPWSTR*

當這個方法傳回時，包含包含項目顯示名稱之緩衝區的指標。 此字串長度上限MAX_SYNCMGR_NAME包括終止 Null 字元。 較長字串會被截斷。

傳回值

類型： HRESULT

如果此方法成功，則會傳回 S_OK。 否則，它會傳回 HRESULT 錯誤碼。

備註

如果 GetName 失敗，或在 ppszItemID 中傳回空字串，則處理程式的資料夾中不會顯示同步處理專案，而且同步中心不會嘗試同步處理它。

這個方法所擷取的標識碼可在處理程式的資料夾 UI 中作為 System.DisplayName (PKEY_DisplayName) 屬性使用。

項目負責透過 CoTaskMemAlloc 配置 ppszComment 所指向的字串緩衝區。 同步中心會透過 CoTaskMemFree 解除分配字串緩衝區。

每當呼叫 UpdateItem 方法時，同步中心就會呼叫這個方法。

在較舊的同步管理員實作中，這項資訊是透過 SYNCMGRHANDLERINFO 結構擷取。

範例

下列範例示範這個方法的實作。

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

規格需求

需求	值
最低支援的用戶端	Windows Vista [僅限傳統型應用程式]
最低支援的伺服器	Windows Server 2008 [僅限傳統型應用程式]
目標平台	Windows
標頭	syncmgr.h