Metodo ISyncMgrHandlerInfo::GetTypeLabel (syncmgr.h)

Articolo
03/05/2024

Ottiene un'etichetta per il tipo di gestore. Questo fornisce in genere il modello del dispositivo o una stringa di identità specifica del gestore equivalente.

Sintassi

HRESULT GetTypeLabel(
  [out] LPWSTR *ppszTypeLabel
);

Parametri

[out] ppszTypeLabel

Tipo: LPWSTR*

Quando questo metodo restituisce, contiene un puntatore a un buffer contenente la stringa di etichetta.

Valore restituito

Tipo: HRESULT

Restituisce S_OK se ha esito positivo o un valore di errore in caso contrario. Se il metodo ha esito negativo, ppszTypeLabel contiene una stringa vuota.

Commenti

Il valore dell'etichetta viene visualizzato come proprietà System.Sync.HandlerTypeLabel (PKEY_Sync_HandlerTypeLabel) nell'interfaccia utente della cartella. Sync Center chiama questo metodo ogni volta che viene chiamato il metodo UpdateHandler .

Il gestore è responsabile dell'allocazione del buffer stringa a cui fa riferimento ppszTypeLabel tramite CoTaskMemAlloc. Sync Center dealloca il buffer stringa tramite CoTaskMemFree.

Esempio

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

STDMETHODIMP CMyDeviceHandler::GetTypeLabel(__out LPWSTR *ppszTypeLabel)
{
    LPWSTR pszTypeLabel = NULL;

    HRESULT hr = LoadStringAlloc(g_hmodThisDll, 
                                 IDS_HANDLER_TYPE_LABEL,
                                 &pszTypeLabel);
    if (SUCCEEDED(hr))
    {
        // Duplicate for the caller.
        hr = SHCoAllocString(pszTypeLabel, ppszTypeLabel);
        LocalFree(pszTypeLabel);
    }

    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