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 code | Description |
|---|---|
|
Job was successfully retrieved from the transfer queue. |
|
The job was not found in the queue. |
|
User does not have permission to retrieve the job. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 10, version 1709 [desktop apps only] |
| Minimum supported server |
Windows Server, version 1709 [desktop apps only] |
| Header |
|
| IDL |
|
| Library |
|
| DLL |
|
| IID |
IID_IBackgroundCopyManager is defined as 5CE34C0D-0DC9-4C1F-897C-DAA1B78CEE7C |