Función CfGetTransferKey (cfapi.h)

CfGetTransferKey devuelve TransferKey, que es necesario para iniciar una transferencia de datos a un marcador de posición mediante cfExecute API.

Sintaxis

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

Parámetros

[in] FileHandle

Identificador de archivo del marcador de posición.

[out] TransferKey

Identificador opaco del marcador de posición que se va a atender.

Valor devuelto

Si esta función se ejecuta correctamente, devuelve S_OK. De lo contrario, devuelve un código de error de HRESULT.

Comentarios

Esta API está disponible para proveedores de sincronización que pueden querer iniciar proactivamente una transferencia de datos a un marcador de posición, como alternativa a llamar a CfHydratePlaceholder. CfGetTransferKey devuelve la misma TransferKey que habría devuelto una devolución de llamada de datos de captura. A continuación, el proveedor de sincronización puede pasar TransferKey en llamadas posteriores a cfExecute API. De este modo, el proveedor de sincronización controla la transferencia de datos en lugar del filtro.

Un proveedor de sincronización debe tener READ_DATA o WRITE_DAC acceso al archivo cuya clave de transferencia se va a obtener o se producirá un error en CfGetTransferKey con HRESULT(ERROR_CLOUD_FILE_ACCESS_DENIED)).

TransferKey es válido siempre que fileHandle usado para obtenerlo permanezca abierto. El proveedor de sincronización debe pasar TransferKey a CfExecute para realizar la operación deseada en el archivo o carpeta del marcador de posición. Cuando ya no se usa una TransferKey , debe liberarse mediante CfReleaseTransferKey.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows 10, versión 1709 [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2016 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	cfapi.h
Library	CldApi.lib
Archivo DLL	CldApi.dll

Consulte también

CfHydratePlaceholder

CfExecute

CfReleaseTransferKey