Función CfReportProviderProgress (cfapi.h)

Permite que un proveedor de sincronización notifique el progreso fuera de banda.

Sintaxis

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

Parámetros

[in] ConnectionKey

Clave de conexión que representa un canal de comunicación con el filtro de sincronización.

[in] TransferKey

Identificador opaco del marcador de posición.

[in] ProviderProgressTotal

Progreso total del proveedor de sincronización en respuesta a una devolución de llamada de datos de captura.

[in] ProviderProgressCompleted

Progreso completado del proveedor de sincronización en respuesta a una devolución de llamada de datos de captura.

Valor devuelto

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

Comentarios

El filtro realiza un seguimiento automático del progreso de las hidrataciones, mediante el seguimiento de intervalos transferidos o confirmados en respuesta a FETCH_DATA devoluciones de llamada. Sin embargo, si un proveedor pasa la mayor parte de su tiempo descargando contenido en una ubicación temporal antes de empezar a TRANSFER_DATA al filtro, el filtro no sería consciente de que estas actividades están relacionadas con la solicitud.

Al llamar a CfReportProviderProgress periódicamente, el proveedor de sincronización puede notificar el progreso al filtro, lo que restablece el período de tiempo de espera de 60 segundos correspondiente a la devolución de llamada de CF_CALLBACK_TYPE_FETCH_DATA . Esto también hará que el progreso aparezca más suave.

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

CfReportProviderProgress2

CF_CALLBACK_TYPE