File.Recycle Method
Moves the file to the Recycle Bin and returns the identifier of the new Recycle Bin item.
Namespace: Microsoft.SharePoint.Client
Assemblies: Microsoft.SharePoint.Client.Silverlight (in Microsoft.SharePoint.Client.Silverlight.dll); Microsoft.SharePoint.Client (in Microsoft.SharePoint.Client.dll)
Syntax
'Declaration
<RemoteAttribute> _
Public Function Recycle As ClientResult(Of Guid)
'Usage
Dim instance As File
Dim returnValue As ClientResult(Of Guid)
returnValue = instance.Recycle()
[RemoteAttribute]
public ClientResult<Guid> Recycle()
Return Value
Type: Microsoft.SharePoint.Client.ClientResult<Guid>
Returns a ClientResult<T> instance representing the moving of the files to the Recycle Bin and returns the identifier of the new Recycle Bin.item.
Exceptions
| Exception | Condition |
|---|---|
| [Microsoft.SharePoint.SPFileCheckOutException] | File is checked out to a user who is not the current user. Error code: -2130575306. |
| [Microsoft.SharePoint.SPFileLockException] | Shared lock on the file. Error code: -2147018894. |
| [Microsoft.SharePoint.SPFileLockException] | Exclusive lock on the file. Error code: -2147018887. |
| [System.IO.FileNotFoundException] | File cannot be found. Error code: -2147024894. |
| [System.UnauthorizedAccessException] | The current user has insufficient permissions. Error code: -2147024891. |