Méthode ISyncMgrSyncItem ::GetName (syncmgr.h)

Article
03/06/2024

Obtient le nom complet de l’interface utilisateur de l’élément de synchronisation.

Syntaxe

HRESULT GetName(
  [out] LPWSTR *ppszName
);

Paramètres

[out] ppszName

Type : LPWSTR*

Lorsque cette méthode est retournée, contient un pointeur vers une mémoire tampon contenant le nom d’affichage de l’élément. Cette chaîne est de longueur maximale MAX_SYNCMGR_NAME y compris le caractère null de fin. Les chaînes plus longues sont tronquées.

Valeur retournée

Type : HRESULT

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Si GetName échoue ou si une chaîne vide est retournée dans ppszItemID, l’élément de synchronisation n’est pas affiché dans le dossier du gestionnaire et le Centre de synchronisation ne tente pas de le synchroniser.

L’ID récupéré par cette méthode est disponible dans l’interface utilisateur du dossier du gestionnaire en tant que propriété System.DisplayName (PKEY_DisplayName).

L’élément est chargé d’allouer la mémoire tampon de chaîne pointée par ppszComment via CoTaskMemAlloc. Le Centre de synchronisation libère la mémoire tampon de chaîne via CoTaskMemFree.

Le Centre de synchronisation appelle cette méthode chaque fois que la méthode UpdateItem est appelée.

Dans les anciennes implémentations du Gestionnaire de synchronisation, ces informations étaient récupérées via la structure SYNCMGRHANDLERINFO .

Exemples

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

STDMETHODIMP CMyDeviceSyncItem::GetName(__out LPWSTR *ppszName)
{
    *ppszName = NULL;
    HRESULT hr = SHCoAllocString(_pszItemName, ppszName);
    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