IReplicationTargetAddCleanupExemption Method Ingeniux CMS Content Store API

Adds a new Cleanup Exempt Location to this replication target.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)
Syntax

IReplicationCleanupExemption AddCleanupExemption(
	string locationPath,
	bool exemptAllFiles,
	string exemptSearchPatters = "",
	bool exemptDescendants = true
)

Parameters

locationPath
Type: SystemString
Path of exemption that is relative to replication destination location
exemptAllFiles
Type: SystemBoolean
Whether to excude all Files in this location from cleanup
exemptSearchPatters (Optional)
Type: SystemString
The search pattern for Files that will be excluded from cleanup. Only applies when the exemptAllFiles paramter value is false
exemptDescendants (Optional)
Type: SystemBoolean
Whether to exclude all descendant Directories of this location from cleanup

Return Value

Type: IReplicationCleanupExemption
Newly added Cleanup Exempt Location
Exceptions

ExceptionCondition
ArgumentNullExceptionWhen location path is null or empty
Remarks

The locationPath value doesn't have to point to an existing location when calling this method. However, if this location still doesn't exist during replication, an error will be thrown.

See Also

Reference