IBackgroundCopyJob1::GetStatus method (qmgr.h)

[IBackgroundCopyJob1 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 GetStatus method to retrieve the state of the job.

Syntax

HRESULT GetStatus(
  [out] DWORD *pdwStatus,
  [out] DWORD *pdwWin32Result,
  [out] DWORD *pdwTransportResult,
  [out] DWORD *pdwNumOfRetries
);

Parameters

[out] pdwStatus

State of the job. The state can be set to one or more of the following flags.

Value	Meaning
QM_STATUS_JOB_FOREGROUND	Not supported.
QM_STATUS_JOB_INCOMPLETE	QMGR is still downloading the job.
QM_STATUS_JOB_COMPLETE	The job is complete.
QM_STATUS_JOB_ERROR	An error occurred while processing the job.

[out] pdwWin32Result

Win32 error code. Valid only if the QM_STATUS_JOB_ERROR dwStatus flag is set.

[out] pdwTransportResult

HTTP error code. Valid only if the QM_STATUS_JOB_ERROR dwStatus flag is set.

[out] pdwNumOfRetries

Number of times QMGR tried to download the job after an error occurs. Valid only if the QM_STATUS_GROUP_ERROR dwStatus flag is set.

Return value

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

Return code	Description
S_OK	Successfully retrieved the state of the job.

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

IBackgroundCopyJob1