Skip to content

Latest commit

 

History

History
86 lines (67 loc) · 3.56 KB

nf-bitscfg-ibitsextensionsetup-getcleanuptask.md

File metadata and controls

86 lines (67 loc) · 3.56 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:bitscfg.IBITSExtensionSetup.GetCleanupTask
IBITSExtensionSetup::GetCleanupTask (bitscfg.h)
Use the GetCleanupTask method to retrieve an interface pointer to the cleanup task associated with the virtual directory.
GetCleanupTask
GetCleanupTask method [BITS]
GetCleanupTask method [BITS]
IBITSExtensionSetup interface
IBITSExtensionSetup interface [BITS]
GetCleanupTask method
IBITSExtensionSetup.GetCleanupTask
IBITSExtensionSetup::GetCleanupTask
_drz_ibitsextensionsetup_getcleanuptask
bits.ibitsextensionsetup_getcleanuptask
bitscfg/IBITSExtensionSetup::GetCleanupTask
bits\ibitsextensionsetup_getcleanuptask.htm
Bits
ffa89d5b-7ba1-433b-a93d-032012906258
12/05/2018
GetCleanupTask, GetCleanupTask method [BITS], GetCleanupTask method [BITS],IBITSExtensionSetup interface, IBITSExtensionSetup interface [BITS],GetCleanupTask method, IBITSExtensionSetup.GetCleanupTask, IBITSExtensionSetup::GetCleanupTask, _drz_ibitsextensionsetup_getcleanuptask, bits.ibitsextensionsetup_getcleanuptask, bitscfg/IBITSExtensionSetup::GetCleanupTask
bitscfg.h
Windows
Windows Vista
Windows Server 2003
Bitscfg.idl
BitsMgr.dll
Windows
BITS 1.5 on Windows XP
19H1
IBITSExtensionSetup::GetCleanupTask
bitscfg/IBITSExtensionSetup::GetCleanupTask
c++
APIRef
kbSyntax
COM
BitsMgr.dll
IBITSExtensionSetup.GetCleanupTask

IBITSExtensionSetup::GetCleanupTask

-description

Use the GetCleanupTask method to retrieve an interface pointer to the cleanup task associated with the virtual directory.

-parameters

-param riid [in]

Identifies the task scheduler interface to return in ppTask. For a list of identifiers, see the ITaskScheduler::Activate method.

-param ppUnk [out]

A pointer to the interface specified by riid. Use the interface to modify the properties of the task. Release ppTask when done.

-returns

This method returns S_OK for success. Otherwise, the method returns S_FALSE if a task has not been created for the virtual directory.

-remarks

When you create a virtual directory and enable it for BITS uploads, BITS adds a work item in the Task Scheduler. The work item cleans up the virtual directory once every 12 hours by deleting jobs that have not been modified within the time-out period. To specify the time-out period, set the BITSSessionTimeout IIS extension property.

To change the cleanup schedule, see the BITSCleanupUseDefault BITS IIS extension property.

-see-also

IBITSExtensionSetup::EnableBITSUploads

IBITSExtensionSetup::GetCleanupTaskName