Edit

BG_JOB_PROGRESS structure (bits.h)

  • Article

Provides job-related progress information, such as the number of bytes and files transferred. For upload jobs, the progress applies to the upload file, not the reply file. To view reply file progress, see the BG_JOB_REPLY_PROGRESS structure.

Syntax

typedef struct _BG_JOB_PROGRESS {
  UINT64 BytesTotal;
  UINT64 BytesTransferred;
  ULONG  FilesTotal;
  ULONG  FilesTransferred;
} BG_JOB_PROGRESS;

Members

BytesTotal

Total number of bytes to transfer for all files in the job. If the value is BG_SIZE_UNKNOWN, the total size of all files in the job has not been determined. BITS does not set this value if it cannot determine the size of one of the files. For example, if the specified file or server does not exist, BITS cannot determine the size of the file.

If you are downloading ranges from the file, BytesTotal includes the total number of bytes you want to download from the file.

BytesTransferred

Number of bytes transferred.

FilesTotal

Total number of files to transfer for this job.

FilesTransferred

Number of files transferred.

Requirements

Requirement Value
Minimum supported client Windows XP
Minimum supported server Windows Server 2003
Header bits.h

See also

BG_FILE_PROGRESS

BG_JOB_REPLY_PROGRESS

IBackgroundCopyJob3::AddFileWithRanges

IBackgroundCopyJob::GetProgress