IBackgroundCopyJob::GetState method

Retrieves the state of the job.

Syntax


HRESULT GetState(
  [out] BG_JOB_STATE *pJobState
);

Parameters

pJobState [out]

The state of the job. For example, the state reflects whether the job is in error, transferring data, or suspended. For a list of job states, see the BG_JOB_STATE enumeration.

Return value

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

Return codeDescription
S_OK

The state of the job was successfully retrieved.

E_INVALIDARG

The parameter, pJobState, cannot be NULL.

 

Remarks

If you want to know when a job is in error or has transferred all the files in the job, you can use this method to poll for the state of the job or you can register to receive notification when events occur. For details on registering to receive event notification, see the IBackgroundCopyCallback interface.

Examples

See the example code for the IBackgroundCopyManager::GetJob method.

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_IBackgroundCopyJob is defined as 37668D37-507E-4160-9316-26306D150B12

See also

BG_JOB_STATE
Determining the Status of a Job
IBackgroundCopyCallback

 

 

Show: