Click or drag to resize

ISiteRemoveDITAAlias Method
Removes a single Alias.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
Syntax
Copy
bool RemoveDITAAlias(
	ref IDITAAlias alias
)

Parameters

alias  IDITAAlias
The page to remove/purge

Return Value

Boolean
True if Alias exists, false otherwise.
Exceptions
ExceptionCondition
InvalidOperationExceptionWhen trying to remove Site Root
SecurityExceptionWhen Operating User doesn't have the right to Manage Aliases, or doesn't have full access to the Alias to be removed.
Remarks

if "alias" is null, returns false.

If the Alias is not under Recycle Folder, it will be moved to Recycle Folder. If it is already under Recycle Folder, it will be permanently purged.

Two events are fired during execution of this method: BeforePageDelete and AfterPageDelete.

See Also