Metode ISyncMgrSyncCallback::CanContinue (syncmgr.h)

Artikel
03/02/2024

Menentukan apakah sinkronisasi telah dibatalkan.

Sintaks

HRESULT CanContinue(
  [in] LPCWSTR pszItemID
);

Parameter

[in] pszItemID

Jenis: LPCWSTR

Penunjuk ke buffer yang berisi ID item.

Mengembalikan nilai

Jenis: HRESULT

Tampilkan Nilai	Makna
S_OK	Pembatalan belum diminta. Sinkronisasi dapat dilanjutkan.
S_FALSE	Pembatalan telah diminta. Handler harus memanggil ISyncMgrSyncCallback::ReportProgress, yang menentukan SYNCMGR_PS_CANCELED dalam parameter nStatus .
E_INVALIDARG	Nilai yang ditujukan oleh pszItemID tidak diketahui oleh Pusat Sinkronisasi atau bukan item yang dikelola oleh handler ini.

Jika pszItemID adalah NULL atau string kosong, nilai yang dikembalikan bergantung pada apakah pembatalan telah diminta untuk seluruh handler.

Keterangan

Sinkronisasi dapat dibatalkan oleh pengguna dengan mengklik tugas Hentikan atau Hentikan Semua pada menu konteks atau modul perintah. Ini juga dapat dibatalkan ketika aplikasi memanggil salah satu metode berhenti antarmuka ISyncMgrControl .

Dengan menerapkan fungsionalitas ini sebagai metode terpisah, handler dapat memeriksa pembatalan tanpa melaporkan kemajuan.

Contoh

Contoh berikut menunjukkan penggunaan ISyncMgrSyncCallback::CanContinue dengan metode Synchronize .

HRESULT CMyDeviceHandler::Synchronize(...)
{
    ...

    // Start synchronizing the sync items.

    ...

    // If a cancellation has been requested, stop the sync and exit.
    if (pCallback->CanContinue(pszItemID) == S_FALSE)
    {
        // End the sync operation and exit the function.
        hr = pCallback->ReportProgress(pszItemID,
                                       pszCancelMessage,
                                       SYNCMGR_PS_CANCELED,
                                       uCurrentStep,
                                       uMaxStep,
                                       NULL);
    }
    ...
}

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