ISyncMgrHandler ::GetName, méthode (syncmgr.h)

Article
03/02/2024

Obtient le nom complet du gestionnaire.

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 terminée par null qui reçoit le nom du gestionnaire. Le nom peut être de longueur maximale MAX_SYNCMGR_NAME, y compris le caractère null de fin. Si le nom dépasse cette longueur, il est tronqué.

Valeur retournée

Type : HRESULT

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

Remarques

Le nom du gestionnaire est accessible en tant que propriété System.DisplayName (PKEY_DisplayName) dans le dossier Centre de synchronisation.

Le Centre de synchronisation appelle cette méthode chaque fois que UpdateHandler ou UpdateHandlerCollection est appelé. Si ISyncMgrHandler ::GetName échoue ou retourne une chaîne vide, le gestionnaire n’est pas affiché dans le dossier Centre de synchronisation et le Centre de synchronisation ne tente pas de l’appeler.

Il incombe au gestionnaire d’allouer la mémoire tampon de chaîne à l’aide de CoTaskMemAlloc. Le Centre de synchronisation libère la mémoire tampon via CoTaskMemFree.

ISyncMgrHandler ::GetName remplace l’utilisation de GetHandlerInfo pour récupérer le nom du gestionnaire.

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