Metode ISyncMgrHandler::GetName (syncmgr.h)

Artikel
03/04/2024

Mendapatkan nama tampilan handler.

Sintaks

HRESULT GetName(
  [out] LPWSTR *ppszName
);

Parameter

[out] ppszName

Jenis: LPWSTR*

Ketika metode ini kembali, berisi penunjuk ke buffer yang dihentikan null yang menerima nama handler. Nama dapat memiliki panjang maksimum MAX_SYNCMGR_NAME, termasuk karakter null yang mengakhiri. Jika nama melebihi panjang tersebut, nama akan terpotong.

Nilai kembali

Jenis: HRESULT

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

Keterangan

Nama handler diakses sebagai properti System.DisplayName (PKEY_DisplayName) di folder Pusat Sinkronisasi.

Pusat Sinkronisasi memanggil metode ini kapan saja updateHandler atau UpdateHandlerCollection dipanggil. Jika ISyncMgrHandler::GetName gagal atau mengembalikan string kosong, handler tidak ditampilkan di folder Pusat Sinkronisasi dan Pusat Sinkronisasi tidak akan mencoba memanggilnya.

Handler bertanggung jawab untuk mengalokasikan buffer string menggunakan CoTaskMemAlloc. Sync Center membatalkan alokasi buffer melalui CoTaskMemFree.

ISyncMgrHandler::GetName menggantikan penggunaan GetHandlerInfo untuk mengambil nama handler.

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