Remove-RoyalObject

Remove-RoyalObject

Scripting > Reference > PowerShell Commandlets >

NAME

Remove-RoyalObject
 
 

 

SYNOPSIS

Removes a RoyalObject from its parent (a RoyalFolder or a RoyalDocument)
 
 
 

 

SYNTAX

Remove-RoyalObject [-Object] <RoyalObject> [[-Force] <SwitchParameter>] [<CommonParameters>]
 
 
 

 

DESCRIPTION

This cmdlet removes a RoyalObject from their parent RoyalFolder/RoyalDocument.
 
 

 

PARAMETERS

-Object <RoyalObject>
The RoyalObject that is going to be removed. Use the cmdlet Out-RoyalDocument to save it.
 
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-Force <SwitchParameter>
Using Force remove the RoyalObject immediately (the RoyalObject will not be in the Trashcan).
 
Required? false
Position? 1
Default value False
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
 
 

 

INPUTS

RoyalDocumentLibrary.RoyalObject
The RoyalObject that is going to be removed. Use the cmdlet Out-RoyalDocument to save it.
 
System.Management.Automation.SwitchParameter
Using Force remove the RoyalObject immediately (the RoyalObject will not be in the Trashcan).
 
 
 

 

OUTPUTS

 
---------- EXAMPLE 1 ----------
 
Remove-RoyalObject -Object $folder -Force
 
This command deletes $folder from its parent. Since the parameter -Force is used, the object is NOT kept in the
internal Trashcan.
 
 

 

RELATED LINKS

New-RoyalObject

Move-RoyalObject

Copy-RoyalObject

Set-RoyalObjectValue

Get-RoyalObjectValue

Get-RoyalObject