Metode ISyncMgrHandlerInfo::IsActive (syncmgr.h)

Mendapatkan nilai yang menunjukkan apakah handler dapat disinkronkan.

Sintaks

HRESULT IsActive();

Mengembalikan nilai

Jenis: HRESULT

Mengembalikan S_OK jika handler aktif; 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 ke nilai terakhir yang diketahui. Jika nilai handler terakhir yang diketahui dalam situasi tersebut tidak aktif, Sync Center akan menonaktifkan tugas Penyetelan . Jika nilai handler terakhir yang diketahui aktif, tugas Hapus tidak dinonaktifkan.

Jika bendera SYNCMGR_HCM_QUERY_BEFORE_ACTIVATE atau SYNCMGR_HCM_QUERY_BEFORE_DEACTIVE diatur dalam masker yang dikembalikan dari GetCapabilities, handler harus mengelola status aktivasinya sendiri dan karenanya harus mengembalikan S_OK atau S_FALSE. Nilai pengembalian lainnya akan dianggap sebagai kesalahan.

Keterangan

Jika handler tidak aktif, handler akan muncul di folder Penyiapan Sinkronisasi. Penangan dalam folder tersebut tidak dapat disinkronkan. Untuk memindahkan handler ke folder Sync Center, pengguna memilih tugas Penyetelan pada menu pintasan handler atau dari modul perintah.

Jika handler aktif, maka akan muncul di folder Pusat Sinkronisasi utama. Handler yang aktif dapat disinkronkan baik oleh pengguna atau melalui antarmuka ISyncMgrControl . Untuk memindahkan handler ke folder Penyiapan Sinkronisasi, pengguna memilih tugas Hapus pada menu pintasan handler atau pada modul perintah.

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 aktif.

STDMETHODIMP CMyDeviceHandler::IsActive()
{
    // Return a previously-calculated value.
    return (_fIsActive ? 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