Please enable JavaScript to view this site.

Altova FlowForce Server 2022 Advanced Edition

Full path: /system/sftp/rmdir-wildcard

 

Deletes from the SFTP server any directories that match a wildcard, for example, TEST*.

 

This function returns a list of strings with the deleted directory names, if the execution has been successful. Otherwise, the outcome depends on the Abort on error parameter, as further described below.

 

 

Parameters

Name

Type

Description

SFTP Connection

SFTP Connection

A FlowForce object that provides the SFTP connection. To obtain the SFTP connection object, call the /system/sftp/connect function first, in a separate execution step.

 

Mandatory parameter.

Wildcard

string

Mandatory parameter. Specifies a wildcard, for example, TEST*. Any directories matching the wildcard will be deleted. Directories must be empty for the operation to succeed. See also Wildcards in SFTP functions.

Abort on error

boolean

This Boolean parameter determines what should be the return value of the function if the execution fails. If this parameter is false, the function will return the list of directory names that were successfully deleted and omit those directory names that for some reason could not be deleted. If this parameter is true, the job execution is aborted in the first directory that could not be deleted. The default value is true.

 

© 2015-2021 Altova GmbH