Full path: /system/sftp/list-directories
Returns a list of directories from the SFTP Server as a sequence of string.
This function returns a list of stings with 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 |
Specifies the directory wildcard to match. |
Abort on error |
boolean |
This Boolean parameter determines what should be the return value of the function if execution fails. If this parameter is false, the function will return Boolean false as well. If this parameter is true, the job execution is aborted. The default value is true. |
