Função CfGetTransferKey (cfapi.h)

CfGetTransferKey retorna TransferKey, que é necessário para iniciar uma transferência de dados para um espaço reservado usando a API CfExecute .

Sintaxe

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

Parâmetros

[in] FileHandle

O identificador de arquivo do espaço reservado.

[out] TransferKey

Um identificador opaco para o espaço reservado a ser atendido.

Retornar valor

Se essa função for bem-sucedida, ela retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Essa API está disponível para provedores de sincronização que podem querer iniciar proativamente uma transferência de dados para um espaço reservado, como uma alternativa para chamar CfHydratePlaceholder. CfGetTransferKey retorna a mesma TransferKey que um retorno de chamada de dados de busca teria retornado. Em seguida, o provedor de sincronização pode passar a TransferKey em chamadas subsequentes para a API CfExecute . Dessa forma, a transferência de dados é orientada pelo provedor de sincronização em vez do filtro.

Um provedor de sincronização deve ter READ_DATA ou WRITE_DAC acesso ao arquivo cuja chave de transferência deve ser obtida ou CfGetTransferKey falhará com HRESULT(ERROR_CLOUD_FILE_ACCESS_DENIED).

A TransferKey é válida desde que o FileHandle usado para obtê-lo permaneça aberto. O provedor de sincronização deve passar TransferKey para CfExecute para executar a operação desejada no arquivo de espaço reservado ou pasta. Quando uma TransferKey não está mais sendo usada, ela deve ser liberada usando CfReleaseTransferKey.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows 10, versão 1709 [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2016 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	cfapi.h
Biblioteca	CldApi.lib
DLL	CldApi.dll

Confira também

CfHydratePlaceholder

CfExecute

CfReleaseTransferKey