Méthode ISyncMgrSyncItemInfo ::GetComment (syncmgr.h)

Article
03/04/2024

Obtient une chaîne qui contient un commentaire concernant l’élément.

Syntaxe

HRESULT GetComment(
  [out] LPWSTR *ppszComment
);

Paramètres

[out] ppszComment

Type : LPWSTR*

Lorsque cette méthode retourne, contient un pointeur vers une mémoire tampon contenant la chaîne de commentaire. Cette chaîne est de longueur maximale MAX_SYNCMGR_NAME y compris le caractère null de fin.

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, ppszComment contient une chaîne vide.

Remarques

Cette chaîne peut être fournie par un élément pour afficher un résumé de son contenu, par exemple, « 32 contacts » ou « 13 chansons ». La chaîne peut avoir une longueur maximale de MAX_SYNCMGR_NAME y compris le caractère null de fin.

La valeur du commentaire s’affiche sous la forme de la propriété System.Sync.Comments (PKEY_Sync_Comments) dans l’interface utilisateur du dossier lorsqu’une synchronisation n’est pas effectuée.

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

L’élément est responsable de l’allocation de la mémoire tampon de chaîne pointée vers ppszComment via CoTaskMemAlloc. Le Centre de synchronisation libère la mémoire tampon de chaîne via CoTaskMemFree.

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