ISyncMgrSyncCallback::CanContinue-Methode (syncmgr.h)

Artikel
03/02/2024

Bestimmt, ob die Synchronisierung abgebrochen wurde.

Syntax

HRESULT CanContinue(
  [in] LPCWSTR pszItemID
);

Parameter

[in] pszItemID

Typ: LPCWSTR

Ein Zeiger auf einen Puffer, der die ID des Elements enthält.

Rückgabewert

Typ: HRESULT

Rückgabewert	Bedeutung
S_OK	Eine Stornierung wurde nicht angefordert. Die Synchronisierung kann fortgesetzt werden.
S_FALSE	Eine Stornierung wurde angefordert. Der Handler sollte ISyncMgrSyncCallback::ReportProgress aufrufen und SYNCMGR_PS_CANCELED im nStatus-Parameter angeben.
E_INVALIDARG	Der Wert, auf den von pszItemID verwiesen wird, ist dem Synchronisierungscenter entweder unbekannt oder ist kein von diesem Handler verwaltetes Element.

Wenn pszItemIDNULL oder eine leere Zeichenfolge ist, hängt der Rückgabewert davon ab, ob für den gesamten Handler ein Abbruch angefordert wurde.

Hinweise

Eine Synchronisierung kann vom Benutzer abgebrochen werden, indem er im Kontextmenü oder im Befehlsmodul auf die Aufgabe Alle beenden oder beenden klickt. Sie kann auch abgebrochen werden, wenn eine Anwendung eine der Stoppmethoden der ISyncMgrControl-Schnittstelle aufruft .

Durch die Implementierung dieser Funktionalität als separate Methode kann der Handler auf einen Abbruch überprüfen, ohne den Fortschritt zu melden.

Beispiele

Das folgende Beispiel zeigt die Verwendung von ISyncMgrSyncCallback::CanContinue durch die Synchronize-Methode .

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);
    }
    ...
}

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2008 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	syncmgr.h

Freigeben über