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

Статья
02/23/2024

Указывает отображаемое имя для задания. Как правило, отображаемое имя используется для идентификации задания в пользовательском интерфейсе.

Синтаксис

HRESULT SetDisplayName(
  [in] LPCWSTR Val
);

Параметры

[in] Val

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

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

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

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

Отображаемое имя изначально задается при создании задания. Дополнительные сведения об указании отображаемого имени при создании задания см. в разделе Метод IBackgroundCopyManager::CreateJob .

Требования

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

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

IBackgroundCopyJob::GetDisplayName

IBackgroundCopyManager::CreateJob

Share via