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

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

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 de l’étiquette s’affiche sous la forme de la propriété System.Sync.ItemTypeLabel (PKEY_Sync_ItemTypeLabel) dans l’interface utilisateur du dossier. Le Centre de synchronisation appelle cette méthode chaque fois que la méthode UpdateHandler ou UpdateItem est appelée.

L’élément 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.

Configuration requise