Folder.PurgeFolder Method

Delete a folder from the database
Public Shared Sub PurgeFolder( _ 
ByVal folder_id As EntityID, _ 
ByVal recursive As Boolean, _ 
ByVal purge_files As Boolean, _ 
ByVal db As IDatabase, _ 
ByVal client As IClient _ 
)
This language is not supported or no code example is available.
public static void PurgeFolder( 
EntityID folder_id, 
bool recursive, 
bool purge_files, 
IDatabase db, 
IClient client 
)
This language is not supported or no code example is available.
public:  
static void PurgeFolder( 
EntityID^ folder_id, 
bool recursive, 
bool purge_files, 
IDatabase^ db, 
IClient^ client 
)
This language is not supported or no code example is available.
public static function PurgeFolder( 
folder_id : EntityID, 
recursive : boolean, 
purge_files : boolean, 
db : IDatabase, 
client : IClient 
);
This language is not supported or no code example is available.

Parameters

folder_id
EntityID

the id of the folder to delete

recursive
bool

whether or not to delete recursively

purge_files
bool

whether or not to purge files - if this off, then we won't - and we will get referential integrity (just a double check)

db
IDatabase

the db used

client
IClient

.NET Framework

Supported in: 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1

In this article

Definition