IBackgroundCopyManager::GetJob method

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

JobID [in]

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

ppJob [out]

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 codeDescription
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

Minimum supported client

Windows XP

Minimum supported server

Windows Server 2003

Header

Bits.h

IDL

Bits.idl

Library

Bits.lib

DLL

QmgrPrxy.dll

IID

IID_IBackgroundCopyManager is defined as 5CE34C0D-0DC9-4C1F-897C-DAA1B78CEE7C

See also

IBackgroundCopyJob
IBackgroundCopyJob::GetId
IBackgroundCopyManager::EnumJobs
IBackgroundCopyManager::CreateJob

 

 

Show: