SharePointFileInfoProvider.RecycleFile Method

Moves the specified file to the recycle bin of the SharePoint server. Deletes the file from the local library. Returns the identifier of the new recycle bin item on SharePoint. Recycling a non-existent file within SharePoint library (i.e. file is out of sync) returns empty GUID and deletes the file from the local library as well.

Namespace: CMS.SharePoint
Assembly: CMS.SharePoint (in CMS.SharePoint.dll) Version: 11.0.0

Syntax

public static Guid RecycleFile(
	SharePointFileInfo fileInfo
)

Parameters

fileInfo

Type: CMS.SharePoint.SharePointFileInfo
SharePoint file to be recycled on the SharePoint server

Return Value

Type: Guid
GUID of the new recycle bin item on SharePoint, or Empty when file does not exist.

Exceptions

Exception	Condition
SharePointConnectionNotFoundException	Thrown when the SharePoint library has no valid connection defined.
Exception	Thrown in case of unexpected error condition.