Edit

Share via

IBackgroundCopyGroup::GetJob 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 GetJob method to retrieve a job from the group.

Syntax

HRESULT GetJob(
  [in]  GUID                jobID,
  [out] IBackgroundCopyJob1 **ppJob
);

Parameters

[in] jobID

Identifies the job to retrieve.

[out] ppJob

Pointer to an IBackgroundCopyJob1 interface pointer. Use the interface to add files and retrieve the state of the job.

Return value

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

Return code Description
S_OK
 Successfully retrieved the job from the group.
QM_E_ITEM_NOT_FOUND
 Could not find the job in the group.

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