Metode ISyncMgrSyncItem::GetName (syncmgr.h)

Artikel
03/02/2024

Mendapatkan nama tampilan UI dari item sinkronisasi.

Sintaks

HRESULT GetName(
  [out] LPWSTR *ppszName
);

Parameter

[out] ppszName

Jenis: LPWSTR*

Ketika metode ini kembali, berisi penunjuk ke buffer yang berisi nama tampilan item. String ini memiliki panjang maksimum MAX_SYNCMGR_NAME termasuk karakter null yang mengakhiri. String yang lebih panjang dipotong.

Nilai kembali

Jenis: HRESULT

Jika metode ini berhasil, metode akan mengembalikan S_OK. Jika tidak, kode kesalahan HRESULT akan dikembalikan.

Keterangan

Jika GetName gagal atau string kosong dikembalikan dalam ppszItemID, item sinkronisasi tidak ditampilkan di folder handler dan Sync Center tidak akan mencoba menyinkronkannya.

ID yang diambil oleh metode ini tersedia di antarmuka pengguna folder handler sebagai properti System.DisplayName (PKEY_DisplayName).

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

Pusat Sinkronisasi memanggil metode ini setiap kali metode UpdateItem dipanggil.

Dalam implementasi Sync Manager yang lebih lama, informasi ini diambil melalui struktur SYNCMGRHANDLERINFO .

Contoh

Contoh berikut menunjukkan implementasi metode ini.

STDMETHODIMP CMyDeviceSyncItem::GetName(__out LPWSTR *ppszName)
{
    *ppszName = NULL;
    HRESULT hr = SHCoAllocString(_pszItemName, ppszName);
    return hr;
}

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