ITransferAdviseSink::UpdateProgress メソッド (shobjidl_core.h)

UI で転送の進行状況の状態を更新します。

構文

HRESULT UpdateProgress(
  [in] ULONGLONG ullSizeCurrent,
  [in] ULONGLONG ullSizeTotal,
  [in] int       nFilesCurrent,
  [in] int       nFilesTotal,
  [in] int       nFoldersCurrent,
  [in] int       nFoldersTotal
);

パラメーター

[in] ullSizeCurrent

種類: ULONGLONG

現在の操作で処理されたバイト数。

[in] ullSizeTotal

種類: ULONGLONG

現在の操作の合計バイト数。

[in] nFilesCurrent

型: int

現在の操作で処理されたファイルの数。

[in] nFilesTotal

型: int

操作内のファイルの合計数。 このメソッドの最後の呼び出し以降に値が変更されていないことを示すには、0 に設定します。

[in] nFoldersCurrent

型: int

現在の操作で処理されたフォルダーの数。

[in] nFoldersTotal

型: int

操作内のフォルダーの合計数。 このメソッドの最後の呼び出し以降に値が変更されていないことを示すには、0 に設定します。

戻り値

型: HRESULT

このメソッドは、成功すると S_OK を返します。 そうでない場合は、HRESULT エラー コードを返します。

注釈

このメソッドの最後の呼び出し以降に合計が変更されていないことを示すには、 ullSizeTotal、 nFilesTotal、 および nFoldersTotal を 0 に設定します。

このメソッドの最後の呼び出し以降に進行状況が変更されていないことを示すには、6 つのパラメーターすべてを 0 に設定します。

実装者への注意

この関数の実装者は、ユーザーが [キャンセル ] ボタンをクリックしたときなど、操作が完了する前に操作を終了する必要がある場合にエラー コードを返す必要があります。

要件

要件	値
サポートされている最小のクライアント	Windows Vista [デスクトップ アプリのみ]
サポートされている最小のサーバー	Windows Server 2008 [デスクトップ アプリのみ]
対象プラットフォーム	Windows
ヘッダー	shobjidl_core.h (Shobjidl.h を含む)