Метод IBITSExtensionSetup::GetCleanupTaskName (bitscfg.h)

Используйте метод GetCleanupTaskName , чтобы получить имя задачи очистки, связанной с виртуальным каталогом.

Синтаксис

HRESULT GetCleanupTaskName(
  [out] BSTR *pTaskName
);

Параметры

[out] pTaskName

Строка, завершающаяся значением NULL, содержащая имя задачи очистки, связанной с виртуальным каталогом. Если значение РАВНО NULL, bits не создала задачу очистки для виртуального каталога. По завершении вызовите функцию SysFreeString , чтобы освободить pTaskName.

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

Этот метод возвращает S_OK для успешного выполнения. В противном случае метод возвращает S_FALSE , если имя задачи не указано для виртуального каталога.

Комментарии

Когда вы создаете виртуальный каталог и включаете его для отправки BITS, BITS добавляет рабочий элемент в планировщик задач. Рабочий элемент очищает виртуальный каталог каждые 12 часов, удаляя задания, которые не были изменены в течение периода ожидания. Чтобы указать период ожидания, задайте свойство расширения IIS BITSSessionTimeout .

Используйте имя pTaskName в качестве входного параметра для Schtasks.exe исполняемого файла, который можно использовать для изменения свойств задачи очистки из скрипта.

Требования

Требование Значение
Минимальная версия клиента Windows Vista
Минимальная версия сервера Windows Server 2003
Целевая платформа Windows
Header bitscfg.h
DLL BitsMgr.dll
Распространяемые компоненты BITS 1.5 в Windows XP

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

IBITSExtensionSetup::EnableBITSUploads

IBITSExtensionSetup::GetCleanupTask