list-directories
If execution is successful, the list-directories function returns the list of directory names (from an SFTP server) that match the specified wildcard. Otherwise, the outcome depends on the Abort on error parameter (see below).
Parameters
Name | Type | Description |
|---|---|---|
SFTP Connection | SFTP Connection | Mandatory parameter. This is a FlowForce object that establishes an SFTP connection. To get the SFTP connection object, call the /system/sftp/connect function first, in a separate execution step. |
Wildcard | string | Mandatory parameter. Specifies a directory wildcard. Directory names matching the wildcard will be listed. See also Wildcards in SFTP functions. |
Abort on error | boolean | Optional parameter. This parameter determines the outcome of a job in which an error has occurred. If the Abort on error parameter is true, job execution will be terminated. If the Abort on error parameter is false, FlowForce Server will ignore errors and continue job execution. The default value is true. |