Skip to main content

TdxCloudStorageItem.MoveToTrash Method

Moves the online resource to the “Trash” special folder.

Declaration

procedure MoveToTrash; virtual;

Remarks

Call this procedure to move the file or folder corresponding to the current metadata container to the “Trash” special folder. If the current online resource is a non-empty folder, the MoveToTrash procedure also trashes every nested file and folder at all nesting levels. The trash operation can take a noticeable amount of time depending on the total resource count. If the resource is already within the “Trash” folder (that is, the Trashed property returns True), a MoveToTrash procedure call produces no effect.

A MoveToTrash procedure call raises an exception if the current online resource does not support this operation. For instance, you cannot place a special or root folder in the “Trash” folder. Refer to the descriptions of the MoveToTrash procedure implementations of TdxCloudStorageItem class descendants for additional information.

Note

A single MoveToTrash procedure call sends only a single resource trash operation request to the connected cloud file storage’s server regardless of the nested resource count if the trashed resource is a non-empty folder. The cloud storage component raises the OnItemMovedToTrash event for every successful file or folder trash request. If a MoveToTrash procedure call results in an error, the OnError event occurs instead.

See Also