CfReportProviderProgress 関数 (cfapi.h)
同期プロバイダーが帯域外の進行状況を報告できるようにします。
構文
HRESULT CfReportProviderProgress(
[in] CF_CONNECTION_KEY ConnectionKey,
[in] CF_TRANSFER_KEY TransferKey,
[in] LARGE_INTEGER ProviderProgressTotal,
[in] LARGE_INTEGER ProviderProgressCompleted
);
パラメーター
[in] ConnectionKey
同期フィルターを使用する通信チャネルを表す接続キー。
[in] TransferKey
プレースホルダーへの不透明なハンドル。
[in] ProviderProgressTotal
フェッチ データ コールバックに応答する同期プロバイダーの進行状況の合計。
[in] ProviderProgressCompleted
フェッチ データ コールバックに応答する同期プロバイダーの完了した進行状況。
戻り値
この関数が成功すると、 が返されます S_OK
。 そうでない場合は、HRESULT エラー コードを返します。
注釈
フィルターは、コールバックに応答して転送または受信確認される範囲を追跡することで、ハイドレーション の進行状況FETCH_DATA 自動的に追跡します。 ただし、プロバイダーがフィルターにTRANSFER_DATAする前に一時的な 場所にコンテンツ をダウンロードする時間の大部分を費やした場合、フィルターはそれ以外の場合、これらのアクティビティが要求に関連する何らかの方法であることを認識しません。
CfReportProviderProgress を定期的に呼び出すことで、同期プロバイダーはフィルターに進行状況を報告できるため、CF_CALLBACK_TYPE_FETCH_DATA コールバックに対応する 60 秒のタイムアウト期間をリセットできます。 これにより、進行状況がスムーズに表示されます。
要件
要件 | 値 |
---|---|
サポートされている最小のクライアント | Windows 10、バージョン 1709 [デスクトップ アプリのみ] |
サポートされている最小のサーバー | Windows Server 2016 [デスクトップ アプリのみ] |
対象プラットフォーム | Windows |
ヘッダー | cfapi.h |
Library | CldApi.lib |
[DLL] | CldApi.dll |