Remove-KFItem

Syntax

Remove-KFItem
  [-ToRecycleBin[:$true]]
  [-ThrowErrors[:$true]]

Support

>= kenaflow 1.0.0

Return

Nothing.

Description

If this Cmdlet is used in a workflow script, the SharePoint element currently being processed by the workflow will be deleted after the script processing is complete.

The -ToRecycleBin parameter can be used to move the item to the Recycle Bin of the Web page collection. This is the default behaviour! If, however, the element is to be permanently deleted, the parameter must be used in this way: -ToRecycleBin:$false.

Parameters

[-ToRecycleBin[:$true]]

Remove item permanently or move it the recycle bin (default).

[-ThrowErrors[:$true]]

This is a default parameter for all kenaflow cmdlets. If set to $true (default!) the engine will pass exception within the cmdlet to the script for further handling.

Example

Remove-KFItem -ToRecycleBin:$false

Discussion