Méthode ISyncMgrHandlerInfo ::GetTypeLabel (syncmgr.h)

Article
03/04/2024

Obtient une étiquette pour le type de gestionnaire. Cela fournit généralement le modèle de l’appareil ou une chaîne d’identité équivalente spécifique au gestionnaire.

Syntaxe

HRESULT GetTypeLabel(
  [out] LPWSTR *ppszTypeLabel
);

Paramètres

[out] ppszTypeLabel

Type : LPWSTR*

Lorsque cette méthode retourne, contient un pointeur vers une mémoire tampon contenant la chaîne d’étiquette.

Valeur retournée

Type : HRESULT

Retourne S_OK en cas de réussite, ou une valeur d’erreur dans le cas contraire. Si la méthode échoue, ppszTypeLabel contient une chaîne vide.

Remarques

La valeur d’étiquette s’affiche sous la forme de la propriété System.Sync.HandlerTypeLabel (PKEY_Sync_HandlerTypeLabel) dans l’interface utilisateur du dossier. Le Centre de synchronisation appelle cette méthode chaque fois que la méthode UpdateHandler est appelée.

Le gestionnaire est responsable de l’allocation de la mémoire tampon de chaîne pointée par ppszTypeLabel via CoTaskMemAlloc. Le Centre de synchronisation libère la mémoire tampon de chaîne via CoTaskMemFree.

Exemples

L’exemple suivant montre une implémentation de cette méthode.

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;
}

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	syncmgr.h

Partager via