2.14.2.24 pe_rmdir

Contents

Brief Information

Delete subfolder in Project Explorer

Additional Information

This feature is updated in Origin 2017 SR0. It is supported to specify the path of folder. For more details, please refer to Release Notes.

Command Line Usage

1. pe_rmdir folder:= "Folder1";

2. pe_rmdir folder:= "/Folder1/Folder3" folpromt:=1 pgpromt:=1;

X-Function Execution Options

Please refer to the page for additional option switches when accessing the x-function from script

Variables

Display
Name 		Variable
Name 		I/O
and
Type 		Default
Value 		Description
Subfolder Name folder

Input

string

Specify the name and the path of the folder to delete.

Folder Deletion Prompt folpromt

Input

int

1

Specify whether to prompt for folder deletion. If TRUE(1), Origin will prompt the user to verify before deleting the folder.

Page Deletion Prompt pgpromt

Input

int

1

Specify whether to prompt for deletion of pages in subfolder. If TRUE(1), Origin will prompt the user to verify before deleting the pages.

Description

This X-Function is used to delete a subfolder in Project Explorer. You can use both absolute or relative way to change current path, like "/FolderA/FolderB" or "../FolderB".

Note: If you only specify the name of folder without the path, please active its parent folder at first.

Examples

To delete a directory named myDir in the root directory, try the following command: 

pe_cd;
pe_rmdir myDir folpromt:=1 pgpromt:=1;

Or 

// It has been supported to specify the folder name directly since Origin 2017 SR0.
pe_rmdir folder:= "/myDir" folpromt:=1 pgpromt:=1;