Share via


DbMaintenanceFileCleanupTask Class

Definition

public ref class DbMaintenanceFileCleanupTask : Microsoft::SqlServer::Management::DatabaseMaintenance::DatabaseMaintenanceBaseTask, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Management::DatabaseMaintenance::IContextSelection, Microsoft::SqlServer::Management::DatabaseMaintenance::IDbMaintenanceFileCleanUpTaskInterface, Microsoft::SqlServer::Management::DatabaseMaintenance::ITaskDescriptionInterface
[Microsoft.SqlServer.Dts.Runtime.DtsTask(IconResource="FileCleanupTaskIcon", LocalizationType=typeof(Microsoft.SqlServer.Management.DatabaseMaintenance.MaintFileCleanupTask), RequiredProductLevel=Microsoft.SqlServer.Dts.Runtime.DTSProductLevel.None, TaskContact="File Cleanup Task; Microsoft Corporation; Microsoft SQL Server 2014; © 2014 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DBMAINT90", UITypeName="Microsoft.SqlServer.Management.DatabaseMaintenance.DbMaintTaskFileCleanupUI, Microsoft.SqlServer.MaintenancePlanTasksUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("8e9ba4eb-9e3d-427d-932b-a8c06f7d6e27")]
public class DbMaintenanceFileCleanupTask : Microsoft.SqlServer.Management.DatabaseMaintenance.DatabaseMaintenanceBaseTask, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Management.DatabaseMaintenance.IContextSelection, Microsoft.SqlServer.Management.DatabaseMaintenance.IDbMaintenanceFileCleanUpTaskInterface, Microsoft.SqlServer.Management.DatabaseMaintenance.ITaskDescriptionInterface
[<Microsoft.SqlServer.Dts.Runtime.DtsTask(IconResource="FileCleanupTaskIcon", LocalizationType=typeof(Microsoft.SqlServer.Management.DatabaseMaintenance.MaintFileCleanupTask), RequiredProductLevel=Microsoft.SqlServer.Dts.Runtime.DTSProductLevel.None, TaskContact="File Cleanup Task; Microsoft Corporation; Microsoft SQL Server 2014; © 2014 Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DBMAINT90", UITypeName="Microsoft.SqlServer.Management.DatabaseMaintenance.DbMaintTaskFileCleanupUI, Microsoft.SqlServer.MaintenancePlanTasksUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("8e9ba4eb-9e3d-427d-932b-a8c06f7d6e27")>]
type DbMaintenanceFileCleanupTask = class
    inherit DatabaseMaintenanceBaseTask
    interface IContextSelection
    interface IDTSComponentPersist
    interface IDbMaintenanceFileCleanUpTaskInterface
    interface ITaskDescriptionInterface
Public Class DbMaintenanceFileCleanupTask
Inherits DatabaseMaintenanceBaseTask
Implements IContextSelection, IDbMaintenanceFileCleanUpTaskInterface, IDTSComponentPersist, ITaskDescriptionInterface
Inheritance
Attributes
Implements

Constructors

DbMaintenanceFileCleanupTask()

Properties

AgeBased
BypassPrepare

Gets or sets a Boolean that indicates whether the Execute SQL task skips preparation of the statement when sending the SQL statement to the relational database management system (RDBMS).

(Inherited from ExecuteSQLTask)
CleanSubFolders
CodePage

Gets or sets the code page to use when translating variable values that are stored as Unicode wide chars to multi-bytes. Translation occurs either when storing values to or extracting values from databases.

(Inherited from ExecuteSQLTask)
Connection

Gets or sets the name of the connection manager that connects to the relational database management system (RDBMS) where the Execute SQL task is run.

(Inherited from ExecuteSQLTask)
DatabaseSelectionType (Inherited from DatabaseMaintenanceBaseTask)
DeleteSpecificFile
ExecutionValue

Returns the number of rows affected by the SQL statement or statements.

(Inherited from ExecuteSQLTask)
ExtendedLogging (Inherited from DatabaseMaintenanceBaseTask)
FileExtension
FilePath
FileTypeSelected
FolderPath
IgnoreDatabasesInNotOnlineState (Inherited from DatabaseMaintenanceBaseTask)
IsStoredProcedure

Gets or sets a Boolean that indicates whether the SQL statement specified by the Execute SQL task is a stored procedure.

(Inherited from ExecuteSQLTask)
LocalConnectionForLogging (Inherited from DatabaseMaintenanceBaseTask)
ObjectTypeSelection (Inherited from DatabaseMaintenanceBaseTask)
OlderThanTimeUnits
OlderThanTimeUnitType
ParameterBindings

Returns an object that implements IDTSParameterBindings.

(Inherited from ExecuteSQLTask)
ResultSetBindings

Returns an object that implements IDTSParameterBindings.

(Inherited from ExecuteSQLTask)
ResultSetType

Gets or sets a value that indicates the type of result set returned by the SQL statement that the Execute SQL tasks runs.

(Inherited from ExecuteSQLTask)
RunId (Inherited from DatabaseMaintenanceBaseTask)
SelectedDatabases (Inherited from DatabaseMaintenanceBaseTask)
SelectedTables (Inherited from DatabaseMaintenanceBaseTask)
ServerVersion (Inherited from DatabaseMaintenanceBaseTask)
SqlBatchCommands (Inherited from DatabaseMaintenanceBaseTask)
SqlStatementSource

Gets or sets the name of the source that contains the SQL statement that the Execute SQL task runs.

(Inherited from ExecuteSQLTask)
SqlStatementSourceType

Gets or sets a value that indicates the type of source that contains the SQL statement that the Execute SQL task runs.

(Inherited from ExecuteSQLTask)
TableSelectionType (Inherited from DatabaseMaintenanceBaseTask)
TargetServerVersion (Inherited from Task)
TaskAllowesDatbaseSelection
TaskAllowesTableSelection
TaskConnectionName (Inherited from DatabaseMaintenanceBaseTask)
TaskName (Inherited from DatabaseMaintenanceBaseTask)
TaskNameWasModified (Inherited from DatabaseMaintenanceBaseTask)
TimeOut

Gets or sets an integer that indicates the maximum number of seconds the task can run before timing out.

(Inherited from ExecuteSQLTask)
TypeConversionMode

Gets or sets the conversion mode used by the Execute SQL Task.

(Inherited from ExecuteSQLTask)
Version

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.

(Inherited from Task)

Methods

CanDowngradeTo(Int32) (Inherited from DatabaseMaintenanceBaseTask)
CanUpdate(String)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.

(Inherited from Task)
CopyTo(DatabaseMaintenanceBaseTask)
DowngradeTo(Int32, XmlElement) (Inherited from DatabaseMaintenanceBaseTask)
Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)
GetConnectionID(Connections, String)

Gets a String containing the ID of the connection.

(Inherited from Task)
GetConnectionName(Connections, String)

Gets a String containing the name of the connection.

(Inherited from Task)
GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) (Inherited from DatabaseMaintenanceBaseTask)
LoadFromXML(XmlElement, IDTSInfoEvents)
OnAddedToTaskHost(TaskHost) (Inherited from DatabaseMaintenanceBaseTask)
SaveToXML(XmlDocument, IDTSInfoEvents)
Update(String)

*** Member deprecated; see Remarks. ***   This method updates the old package XML with the new package XML if CanUpdate(String) is set to true.

(Inherited from Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)
WriteToDTSLog(IDTSLogging, String) (Inherited from DatabaseMaintenanceBaseTask)

Explicit Interface Implementations

ITaskDescriptionInterface.Description

Applies to