Метод IBackgroundCopyJob::GetState (bits.h)

Статья
02/28/2024

Извлекает состояние задания.

Синтаксис

HRESULT GetState(
  [out] BG_JOB_STATE *pVal
);

Параметры

[out] pVal

Состояние задания. Например, состояние отражает, является ли задание ошибкой, передачей данных или приостановлено. Список состояний заданий см. в перечислении BG_JOB_STATE .

Возвращаемое значение

Этот метод возвращает следующие значения HRESULT , а также другие.

Код возврата	Описание
S_OK	Состояние задания успешно извлечено.
E_INVALIDARG	Параметр pJobState не может иметь значение NULL.

Если вы хотите узнать, когда задание находится в состоянии ошибки или было передано все файлы в задании, можно использовать этот метод для опроса состояния задания или регистрации для получения уведомлений о возникновении событий. Дополнительные сведения о регистрации для получения уведомлений о событиях см. в интерфейсе IBackgroundCopyCallback .

Примеры

См. пример кода для метода IBackgroundCopyManager::GetJob .

Требования

Требование	Значение
Минимальная версия клиента	Windows XP
Минимальная версия сервера	Windows Server 2003
Целевая платформа	Windows
Header	bits.h
Библиотека	Bits.lib
DLL	QmgrPrxy.dll

См. также раздел

BG_JOB_STATE , Определение состояния задания, IBackgroundCopyCallback

Share via