Edit

Share via

IBackgroundCopyQMgr::GetGroup method (qmgr.h)

  • Article

[IBackgroundCopyQMgr 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 GetGroup method to retrieve a group from the download queue. The current user can retrieve only groups that they own. If the user has Administrator privileges, the user can retrieve any group from the download queue. Retrieving a group from the queue transfers ownership of the group to the current user.

Syntax

HRESULT GetGroup(
  [in]  GUID                 groupID,
  [out] IBackgroundCopyGroup **ppGroup
);

Parameters

[in] groupID

GUID that uniquely identifies the group in the download queue.

[out] ppGroup

Pointer to an IBackgroundCopyGroup interface pointer. Use this interface to manage the group. For example, add a job to the group and set the properties of the group.

Return value

This method returns the following HRESULT values, as well as others.

Return code Description
S_OK
 Successfully retrieved the group.
QM_E_ITEM_NOT_FOUND
 Could not find the group in the download queue.

Requirements

Requirement Value
Minimum supported client Windows XP
Minimum supported server Windows Server 2003
Target Platform Windows
Header qmgr.h
DLL QmgrPrxy.dll

See also

IBackgroundCopyQMgr