Função CfReportProviderProgress (cfapi.h)

Permite que um provedor de sincronização relate o progresso fora de banda.

Sintaxe

HRESULT CfReportProviderProgress(
  [in] CF_CONNECTION_KEY ConnectionKey,
  [in] CF_TRANSFER_KEY   TransferKey,
  [in] LARGE_INTEGER     ProviderProgressTotal,
  [in] LARGE_INTEGER     ProviderProgressCompleted
);

Parâmetros

[in] ConnectionKey

Uma chave de conexão que representa um canal de comunicação com o filtro de sincronização.

[in] TransferKey

Um identificador opaco para o espaço reservado.

[in] ProviderProgressTotal

O progresso total do provedor de sincronização em resposta a um retorno de chamada de busca de dados.

[in] ProviderProgressCompleted

O progresso concluído do provedor de sincronização em resposta a um retorno de chamada de busca de dados.

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

O filtro controla automaticamente o progresso das hidratações, rastreando intervalos transferidos e/ou reconhecidos em resposta a FETCH_DATA retornos de chamada. No entanto, se um provedor gastar a maior parte do tempo baixando conteúdo para um local temporário antes de começar a TRANSFER_DATA para o filtro, o filtro não saberia que essas atividades estão de alguma forma relacionadas à solicitação.

Chamando CfReportProviderProgress periodicamente, o provedor de sincronização pode relatar o progresso para o filtro, redefinindo o período de tempo limite de 60 segundos correspondente ao retorno de chamada CF_CALLBACK_TYPE_FETCH_DATA . Isso também fará com que o progresso pareça mais suave.

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

CfReportProviderProgress2

CF_CALLBACK_TYPE