CfExecute-Funktion (cfapi.h)

Der Standard Einstiegspunkt für alle verbindungsschlüsselbasierten Platzhaltervorgänge. Er soll von einem Synchronisierungsanbieter verwendet werden, um auf verschiedene Rückrufe von der Plattform zu reagieren.

Syntax

HRESULT CfExecute(
  [in]      const CF_OPERATION_INFO *OpInfo,
  [in, out] CF_OPERATION_PARAMETERS *OpParams
);

Parameter

[in] OpInfo

Informationen zu einem Vorgang auf einem Platzhalter.

[in, out] OpParams

Parameter eines Vorgangs für einen Platzhalter.

Rückgabewert

Wenn diese Funktion erfolgreich ist, wird zurückgegeben S_OK. Andernfalls wird ein Fehlercode HRESULT zurückgegeben.

Hinweise

Ein gültiger Aufruf von CfExecute setzt die Timer aller ausstehenden Rückrufanforderungen zurück, die zum selben Synchronisierungsanbieterprozess gehören.

CfExecute verwendet zwei Argumente mit variabler Größe, d. h. CF_OPERATION_INFO und CF_OPERATION_PARAMETERS, wobei eines den Vorgangstyp identifiziert und das andere detaillierte Vorgangsparameter angibt. Beide Argumente beginnen mit einem StructSize-Feld am Anfang der entsprechenden Strukturen. Aufrufer von CfExecute sind für eine genaue Abrechnung der Strukturgröße verantwortlich.

Die Plattform stellt ConnectionKey, TransferKey und CorrelationVector für alle Rückruffunktionen bereit, die bei CfConnectSyncRoot registriert sind. Darüber hinaus können Synchronisierungsanbieter TransferKey mithilfe von CfGetTransferKey und CorrelationVector mithilfe von CfGetCorrelationVector abrufen.

Optional können Synchronisierungsanbieter der Plattform ein Synchronisierungs-status-Blob bereitstellen. Wenn im Feld SyncStatus in CF_OPERATION_INFO ein Nicht-NULL-Zeiger festgelegt ist, wird sein Inhalt in der Datei beibehalten, bis das letzte Handle für sie entfernt wird. Die Plattform fragt diese Informationen bei fehlgeschlagenen Vorgängen für einen Clouddateiplatzhalter ab. Wenn eine verfügbar ist, verwendet die Plattform die bereitgestellten Informationen, um eine aussagekräftigere und verwertbarere Nachricht für den Benutzer zu erstellen.

Wenn im Feld SyncStatus in CF_OPERATION_INFO ein NULL-Zeiger festgelegt ist, löscht die Plattform die zuvor festgelegte Synchronisierungs-status (sofern vorhanden).

Alle Vorgänge können im Synchronisierungsanbieterprozess in einem beliebigen Threadkontext ausgeführt werden.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows 10, Version 1709 [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2016 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	cfapi.h
Bibliothek	CldApi.lib
DLL	CldApi.dll

Weitere Informationen

CfConnectSyncRoot

CfGetCorrelationVector

CF_OPERATION_INFO

CF_OPERATION_PARAMETERS