IBackgroundCopyGroup interface (qmgr.h)
[IBackgroundCopyGroup is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions. Instead, use the BITS interfaces.]
Use the IBackgroundCopyGroup interface to manage a group. A group contains download jobs. For example, add a job to the group, set the properties of the group, and start and stop the group in the download queue.
Inheritance
The IBackgroundCopyGroup interface inherits from the IUnknown interface. IBackgroundCopyGroup also has these types of members:
Methods
The IBackgroundCopyGroup interface has these methods.
| IBackgroundCopyGroup::CancelGroup Use the CancelGroup method to remove the group from the queue. Files completely downloaded before calling this method are available to the client. You can cancel a group at anytime; however, the group cannot be recovered once it is canceled. |
| IBackgroundCopyGroup::CreateJob Use the CreateJob method to add a new job to the group. A group can contain only one job. |
| IBackgroundCopyGroup::EnumJobs Use the EnumJobs method to retrieve a list of jobs in the group. The list contains only one job. |
| IBackgroundCopyGroup::get_GroupID Use the get_GroupID method to retrieve the group's identifier. |
| IBackgroundCopyGroup::get_Size Use the get_Size method to retrieve the size of all files in the group to download. |
| IBackgroundCopyGroup::GetJob Use the GetJob method to retrieve a job from the group. |
| IBackgroundCopyGroup::GetProgress Use the GetProgress method to retrieve the progress of the download. |
| IBackgroundCopyGroup::GetProp Use the GetProp method to retrieve a property value from the group. |
| IBackgroundCopyGroup::GetStatus Use the GetStatus method to retrieve the state of the group. |
| IBackgroundCopyGroup::ResumeGroup Use the ResumeGroup method to start a group that has been suspended in the download queue. |
| IBackgroundCopyGroup::SetProp Use the SetProp method to set the property value for a group property. |
| IBackgroundCopyGroup::SuspendGroup Use the SuspendGroup method to pause a group in the download queue. New groups, groups that are in error, or groups that have finished downloading are automatically suspended. |
| IBackgroundCopyGroup::SwitchToForeground Use the SwitchToForeground method to download the group in the foreground instead of the background. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP |
| Minimum supported server | Windows Server 2003 |
| Target Platform | Windows |
| Header | qmgr.h |