Metode ISyncMgrHandlerInfo::IsEnabled (syncmgr.h)

Mendapatkan nilai yang menunjukkan apakah handler diaktifkan.

Sintaks

HRESULT IsEnabled();

Mengembalikan nilai

Jenis: HRESULT

Mengembalikan S_OK jika handler diaktifkan; jika tidak, S_FALSE.

Jika handler ingin Sync Center mempertahankan status saat ini, handler dapat mengembalikan E_NOTIMPL. Jika ada nilai lain yang dikembalikan, Sync Center mengatur status handler yang diaktifkan ke nilai terakhir yang diketahui dan mengaktifkan atau menonaktifkan tugas terkait sebagaimana mewajibkan.

Jika bendera SYNCMGR_HCM_QUERY_BEFORE_ENABLE atau SYNCMGR_HCM_QUERY_BEFORE_DISABLE diatur dalam masker yang dikembalikan dari GetCapabilities, handler harus mengelola status diaktifkan sendiri dan oleh karena itu harus mengembalikan S_OK atau S_FALSE. Nilai pengembalian lainnya akan dianggap sebagai kesalahan.

Keterangan

Jika handler dinonaktifkan, baik itu maupun itemnya tidak akan disinkronkan oleh Pusat Sinkronisasi. Selain itu, banyak tindakan yang mungkin tersedia untuk handler—seperti Sync—dihapus atau dinonaktifkan di antarmuka pengguna folder Sync Center.

Nilai ini tersedia di antarmuka pengguna folder sebagai properti System.Sync.Enabled (PKEY_Sync_Enabled).

Pusat Sinkronisasi memanggil metode ini setiap kali metode UpdateHandler dipanggil.

Contoh

Contoh berikut menunjukkan implementasi metode ini yang memanggil fungsi kelas privat untuk mengambil status yang diaktifkan.

STDMETHODIMP CMyDeviceHandler::IsEnabled()
{
    // Return a previously-calculated value.
    return (_fIsEnabled ? S_OK : S_FALSE);
}

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

Lihat juga

Aktifkan

ISyncMgrHandlerInfo