Edit

Share via

IBackgroundCopyGroup::EnumJobs method (qmgr.h)

  • Article

[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 EnumJobs method to retrieve a list of jobs in the group. The list contains only one job.

Syntax

HRESULT EnumJobs(
  [in]  DWORD                    dwFlags,
  [out] IEnumBackgroundCopyJobs1 **ppEnumJobs
);

Parameters

[in] dwFlags

Must be 0.

[out] ppEnumJobs

Pointer to an IEnumBackgroundCopyJobs1 interface pointer. Use the interface to iterate through the list of jobs.

Return value

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

Return code Description
S_OK
 Successfully enumerated the jobs in the group.
E_NOTIMPL
 The dwFlags parameter must be 0.

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

IBackgroundCopyGroup