Metode ISyncMgrSyncItemInfo::GetComment (syncmgr.h)

Artikel
03/02/2024

Mendapatkan string yang berisi komentar mengenai item.

Sintaks

HRESULT GetComment(
  [out] LPWSTR *ppszComment
);

Parameter

[out] ppszComment

Jenis: LPWSTR*

Ketika metode ini kembali, berisi penunjuk ke buffer yang berisi string komentar. String ini memiliki panjang maksimum MAX_SYNCMGR_NAME termasuk karakter null yang mengakhiri.

Nilai kembali

Jenis: HRESULT

Mengembalikan S_OK jika berhasil, atau nilai kesalahan sebaliknya. Jika metode gagal, ppszComment berisi string kosong.

Keterangan

String ini dapat disediakan oleh item untuk menampilkan ringkasan kontennya, misalnya, "32 kontak" atau "13 lagu". String dapat memiliki panjang maksimum MAX_SYNCMGR_NAME termasuk karakter null yang mengakhiri.

Nilai komentar ditampilkan sebagai properti System.Sync.Comments (PKEY_Sync_Comments) di antarmuka pengguna folder saat sinkronisasi tidak dilakukan.

Pusat Sinkronisasi memanggil metode ini setiap kali metode UpdateHandler dipanggil.

Item bertanggung jawab untuk mengalokasikan buffer string yang ditunjukkan oleh ppszComment melalui CoTaskMemAlloc. Sync Center membatalkan alokasi buffer string melalui CoTaskMemFree.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows Vista [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2008 [hanya aplikasi desktop]
Target Platform	Windows
Header	syncmgr.h

Bagikan melalui