(syncmgr.h) ISyncMgrHandler::GetName 方法
取得處理程序的顯示名稱。
語法
HRESULT GetName(
[out] LPWSTR *ppszName
);
參數
[out] ppszName
類型: LPWSTR*
當這個方法傳回時,會包含接收處理程式名稱之 Null 終止緩衝區的指標。 名稱可以是長度上限MAX_SYNCMGR_NAME,包括終止 的 Null 字元。 如果名稱超過該長度,則會將其截斷。
傳回值
類型: HRESULT
如果此方法成功,則會傳回 S_OK。 否則,它會傳回 HRESULT 錯誤碼。
備註
處理程式名稱會當做 Sync Center 資料夾中的 System.DisplayName (PKEY_DisplayName) 屬性來存取。
同步處理中心會在呼叫 UpdateHandler 或 UpdateHandlerCollection 時呼叫此方法。 如果 ISyncMgrHandler::GetName 失敗或傳回空字串,則處理程式不會顯示在同步中心資料夾中,而且同步中心不會嘗試叫用它。
處理程式必須負責使用 CoTaskMemAlloc 配置字串緩衝區。 同步處理中心會透過 CoTaskMemFree 解除分配緩衝區。
ISyncMgrHandler::GetName 會取代 GetHandlerInfo 的使用來擷取處理程序名稱。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows Vista [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2008 [僅限傳統型應用程式] |
目標平台 | Windows |
標頭 | syncmgr.h |