ISyncMgrHandlerInfo::GetComment-Methode (syncmgr.h)

Ruft eine Zeichenfolge ab, die Kommentare zum Handler 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 endenden 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 Handler bereitgestellt werden, um eine Zusammenfassung der Inhalte der Partnerschaft für instance "32 Kontakte" oder "13 Songs" anzuzeigen. Die Zeichenfolge kann eine maximale Länge von MAX_SYNCMGR_NAME einschließlich des abschließenden 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.

Der Handler ist für die Zuweisung des Zeichenfolgenpuffers verantwortlich, auf den ppszComment über CoTaskMemAlloc verweist. Sync Center gibt die Zuordnung des Zeichenfolgenpuffers über CoTaskMemFree auf.

Anforderungen

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