Поделиться через


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

Предоставляет описание задания.

Синтаксис

HRESULT SetDescription(
  [in] LPCWSTR Val
);

Параметры

[in] Val

Строка, завершающаяся нулевым значением, которая предоставляет дополнительные сведения о задании. Длина строки ограничена 1024 символами, не включая признак конца null.

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

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

Код возврата Описание
S_OK
Описание задания успешно задано.
E_INVALIDARG
Параметр pDescription не может иметь значение NULL.
BG_E_STRING_TOO_LONG
Длина описания превышает 1024 символа.
BG_E_INVALID_STATE
Состояние задания не может быть BG_JOB_STATE_CANCELLED или BG_JOB_STATE_ACKNOWLEDGED.

Требования

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

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

IBackgroundCopyJob::GetDescription