Edit

IBackgroundCopyManager::GetJob method (bits.h)

  • Article

Retrieves a specified job from the transfer queue. Typically, your application persists the job identifier, so you can later retrieve the job from the queue.

Syntax

HRESULT GetJob(
  [in]  REFGUID            jobID,
  [out] IBackgroundCopyJob **ppJob
);

Parameters

[in] jobID

Identifies the job to retrieve from the transfer queue. The CreateJob method returns the job identifier.

[out] ppJob

An IBackgroundCopyJob interface pointer to the job specified by JobID. When done, release ppJob.

Return value

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

Return code Description
S_OK
 Job was successfully retrieved from the transfer queue.
BG_E_NOT_FOUND
 The job was not found in the queue.
E_ACCESSDENIED
 User does not have permission to retrieve the job.

Requirements

Requirement Value
Minimum supported client Windows XP
Minimum supported server Windows Server 2003
Target Platform Windows
Header bits.h
Library Bits.lib
DLL QmgrPrxy.dll

See also

IBackgroundCopyJob

IBackgroundCopyJob::GetId

IBackgroundCopyManager::CreateJob

IBackgroundCopyManager::EnumJobs