Fonction CfReportProviderProgress (cfapi.h)

Permet à un fournisseur de synchronisation de signaler la progression hors bande.

Syntaxe

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

Paramètres

[in] ConnectionKey

Clé de connexion représentant un canal de communication avec le filtre de synchronisation.

[in] TransferKey

Handle opaque pour l’espace réservé.

[in] ProviderProgressTotal

Progression totale du fournisseur de synchronisation en réponse à un rappel de récupération de données.

[in] ProviderProgressCompleted

Progression terminée du fournisseur de synchronisation en réponse à un rappel de récupération de données.

Valeur retournée

Si cette fonction réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Le filtre suit automatiquement la progression des hydratations, en suivant les plages qui sont transférées et/ou reconnues en réponse à FETCH_DATA rappels. Toutefois, si un fournisseur passe la majeure partie de son temps à télécharger du contenu vers un emplacement temporaire avant de commencer à TRANSFER_DATA au filtre, le filtre ignore sinon que ces activités sont liées de quelque manière que ce soit à la demande.

En appelant régulièrement CfReportProviderProgress , le fournisseur de synchronisation peut signaler la progression au filtre, réinitialisant ainsi le délai d’expiration de 60 secondes correspondant au rappel CF_CALLBACK_TYPE_FETCH_DATA . Cela rendra également la progression plus fluide.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 10, version 1709 [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2016 (applications de bureau uniquement)
Plateforme cible Windows
En-tête cfapi.h
Bibliothèque CldApi.lib
DLL CldApi.dll

Voir aussi

CfReportProviderProgress2

CF_CALLBACK_TYPE