peoplecodeapi - RemoveDirectory

Syntax

RemoveDirectory(path [, remove_parameters])

where remove_parameters can be in the form:

path_type [+ directory_type]

Description

Use the RemoveDirectory function to remove the directory specified by path . You can also specify whether to remove just the directory, or to delete the directory and all subdirectories, including any files, that is, to remove the entire directory tree.

Parameters

Field or Control	Definition
`path`	Specify the directory to be removed.
`remove_parameters`	Specify additional considerations about the directory to be removed. Specify whether the path is an absolute or relative path. Values are: %FilePath_Relative (default) %FilePath_Absolute The default is %FilePath_Relative. If you specify a relative path, that path is appended to the path constructed from a system-chosen environment variable. A complete discussion of relative paths and environment variables is provided in documentation on the File class. See . If the path is an absolute path, whatever path you specify is used verbatim. You must specify a drive letter as well as the complete path. You canât use any wildcards when specifying a path. The Component Processor automatically converts platform-specific separator characters to the appropriate form for where your PeopleCode program is executing. On a Windows system, UNIX " / " separators are converted to " \ ", and on a UNIX system, Windows "\" separators are converted to "/". Note: The syntax of the file path does not depend on the file system of the platform where the file is actually stored; it depends only on the platform where your PeopleCode is executing. Specify whether to remove only the specified directory or to remove the directory and all its subdirectories. The default is to just remove the specified directory. The valid values are: %Remove_Subtree %Remove_Directory (default)

Field or Control

Definition

path

Specify the directory to be removed.

remove_parameters

Specify additional considerations about the directory to be removed.

Specify whether the path is an absolute or relative path. Values are:

%FilePath_Relative (default)
%FilePath_Absolute

The default is %FilePath_Relative.

If you specify a relative path, that path is appended to the path constructed from a system-chosen environment variable. A complete discussion of relative paths and environment variables is provided in documentation on the File class.

See .

If the path is an absolute path, whatever path you specify is used verbatim. You must specify a drive letter as well as the complete path. You canât use any wildcards when specifying a path.

The Component Processor automatically converts platform-specific separator characters to the appropriate form for where your PeopleCode program is executing. On a Windows system, UNIX " / " separators are converted to " \ ", and on a UNIX system, Windows "\" separators are converted to "/".

Note: The syntax of the file path does not depend on the file system of the platform where the file is actually stored; it depends only on the platform where your PeopleCode is executing.

Specify whether to remove only the specified directory or to remove the directory and all its subdirectories. The default is to just remove the specified directory.

The valid values are:

%Remove_Subtree
%Remove_Directory (default)

Returns

None.