IBackgroundCopyJob::Suspend method (bits.h)

Suspends a job. New jobs, jobs that are in error, and jobs that have finished transferring files are automatically suspended.

Syntax

HRESULT Suspend();

Return value

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

Return code Description
S_OK
Successfully suspended the job.
BG_E_INVALID_STATE
The state of the job cannot be BG_JOB_STATE_CANCELLED or BG_JOB_STATE_ACKNOWLEDGED.

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::Cancel

IBackgroundCopyJob::Resume