CfGetTransferKey-Funktion (cfapi.h)

CfGetTransferKey gibt TransferKey zurück, der erforderlich ist, um eine Übertragung von Daten in einen Platzhalter mithilfe der CfExecute-API zu initiieren.

Syntax

HRESULT CfGetTransferKey(
  [in]  HANDLE          FileHandle,
  [out] CF_TRANSFER_KEY *TransferKey
);

Parameter

[in] FileHandle

Das Dateihandle des Platzhalters.

[out] TransferKey

Ein undurchsichtiges Handle für den zu bedienenden Platzhalter.

Rückgabewert

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

Hinweise

Diese API ist für Synchronisierungsanbieter verfügbar, die möglicherweise eine Übertragung von Daten in einen Platzhalter proaktiv initiieren möchten, als Alternative zum Aufrufen von CfHydratePlaceholder. CfGetTransferKey gibt denselben TransferKey zurück, den ein Abrufdatenrückruf zurückgegeben hätte. Der Synchronisierungsanbieter kann dann den TransferKey in nachfolgenden Aufrufen an die CfExecute-API übergeben. Auf diese Weise wird die Übertragung von Daten vom Synchronisierungsanbieter und nicht vom Filter gesteuert.

Ein Synchronisierungsanbieter sollte READ_DATA oder WRITE_DAC Zugriff auf die Datei haben, deren Übertragungsschlüssel abgerufen werden soll, oder CfGetTransferKey tritt mit HRESULT(ERROR_CLOUD_FILE_ACCESS_DENIED) fehl.

Der TransferKey ist gültig, solange das FileHandle, das zum Abrufen verwendet wird, geöffnet bleibt. Der Synchronisierungsanbieter muss den TransferKey an CfExecute übergeben, um den gewünschten Vorgang für die Platzhalterdatei oder den Ordner auszuführen. Wenn ein TransferKey nicht mehr verwendet wird, muss er mithilfe von CfReleaseTransferKey freigegeben 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

CfHydratePlaceholder

CfExecute

CfReleaseTransferKey