ISyncMgrSyncItemInfo::GetComment-Methode (syncmgr.h)

Artikel
03/04/2024

Ruft eine Zeichenfolge ab, die Kommentare zum Element enthält.

Syntax

HRESULT GetComment(
  [out] LPWSTR *ppszComment
);

Parameter

[out] ppszComment

Typ: LPWSTR*

Wenn diese Methode zurückgibt, enthält einen Zeiger auf einen Puffer, der die Kommentarzeichenfolge enthält. Diese Zeichenfolge hat eine maximale Länge MAX_SYNCMGR_NAME einschließlich des beendenden NULL-Zeichens.

Rückgabewert

Typ: HRESULT

Gibt bei erfolgreicher Ausführung S_OK oder andernfalls einen Fehlerwert zurück. Wenn die Methode fehlschlägt, enthält ppszComment eine leere Zeichenfolge.

Hinweise

Diese Zeichenfolge kann von einem Element bereitgestellt werden, um eine Zusammenfassung des Inhalts anzuzeigen, z. B. "32 Kontakte" oder "13 Songs". Die Zeichenfolge kann eine maximale Länge von MAX_SYNCMGR_NAME einschließlich des beendenden NULL-Zeichens haben.

Der Kommentarwert wird als System.Sync.Comments-Eigenschaft (PKEY_Sync_Comments) auf der Ordnerbenutzeroberfläche angezeigt, wenn keine Synchronisierung ausgeführt wird.

Sync Center ruft diese Methode immer dann auf, wenn die UpdateHandler-Methode aufgerufen wird.

Das Element ist für die Zuordnung des Zeichenfolgenpuffers verantwortlich, auf den von ppszComment über CoTaskMemAlloc verwiesen wird. Sync Center ordnet den Zeichenfolgenpuffer über CoTaskMemFree zu.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	syncmgr.h

Freigeben über