Metodo ISyncMgrSyncItem::GetName (syncmgr.h)

Articolo
03/05/2024

Ottiene il nome visualizzato dell'interfaccia utente dell'elemento di sincronizzazione.

Sintassi

HRESULT GetName(
  [out] LPWSTR *ppszName
);

Parametri

[out] ppszName

Tipo: LPWSTR*

Quando termina, questo metodo contiene un puntatore a un buffer contenente il nome visualizzato dell'elemento. Questa stringa è di lunghezza massima MAX_SYNCMGR_NAME incluso il carattere Null di terminazione. Le stringhe più lunghe vengono troncate.

Valore restituito

Tipo: HRESULT

Se questo metodo ha esito positivo, restituisce S_OK. In caso contrario, restituisce un codice di errore HRESULT .

Commenti

Se GetName ha esito negativo o viene restituita una stringa vuota in ppszItemID, l'elemento di sincronizzazione non viene visualizzato nella cartella del gestore e Sync Center non tenterà di sincronizzarlo.

L'ID recuperato da questo metodo è disponibile nell'interfaccia utente della cartella del gestore come proprietà System.DisplayName (PKEY_DisplayName).

L'elemento è responsabile dell'allocazione del buffer stringa a cui punta ppszComment tramite CoTaskMemAlloc. Sync Center dealloca il buffer delle stringhe tramite CoTaskMemFree.

Sync Center chiama questo metodo ogni volta che viene chiamato il metodo UpdateItem .

Nelle implementazioni precedenti di Sync Manager queste informazioni sono state recuperate tramite la struttura SYNCMGRHANDLERINFO .

Esempio

Nell'esempio seguente viene illustrata un'implementazione di questo metodo.

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

Requisiti

Requisito	Valore
Client minimo supportato	Windows Vista [solo app desktop]
Server minimo supportato	Windows Server 2008 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	syncmgr.h

Condividi tramite