# ListFiles Required Frends version: 5.7+ Required .NET version: 8.0 Compatible Agents: Unknown Source code: {% tabs %} {% tab title="Parameter: Input" %} | Name | Description | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Directory : `PathString` |

Directory from which we want to list files. If you want to list files from the root share, use "/"


Default: -
Example: files/temp

| | {% endtab %} | | {% tab title="Parameter: Connection" %} | Name | Description | | ---------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Server : `String` |

SMB server address or hostname.


Default: -
Example: 127.0.0.1

| | Share : `String` |

SMB share name to connect to.


Default: -
Example: testShare

| | Username : `String` |

Username for SMB authentication.

This needs to be of format domain\username


Default: -
Example: WORKGROUP\Administrator

| | 🗝Password : `String` |

Password for the SMB credentials.


Default: -
Example: Password123

| | OperatingSystem : `Os` |

Defines the operating system of the SMB server.

Options used to determine correct path separator to use.

Possible values:

Defines the operating system of the SMB server.

Options used to determine correct path separator to use.

Defines the operating system of the SMB server.

Options used to determine correct path separator to use.


Default: 2
Example: Linux

| | {% endtab %} | | {% tab title="Parameter: Options" %} | Name | Description | | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | SearchRecursively : `Boolean` |

Whether to list files recursively or not.


Default: False
Example: false

| | PatternMatchingMode : `PatternMatchingMode` |

Define how pattern matching will work.

Possible values:

Define how pattern matching will work.

Define how pattern matching will work.


Default: 2
Example: Regex

| | Pattern : `String` |

Define how pattern matching will work.


Default: -
Example: Regex

| | ThrowErrorOnFailure : `Boolean` |

Whether to throw an error on failure.


Default: True
Example: true

| | ErrorMessageOnFailure : `String` |

Overrides the error message on failure.


Default: -
Example: Custom error message

| | {% endtab %} | | {% tab title="Result: Result" %} | Name | Description | | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Success : `Boolean` |

Indicates if the task completed successfully.
Example: true

| | Files : `FileItem[]` |

List of files in a share
Example: \[{ Name: "foo.txt", Path: "files/temp/foo.txt", SizeInMegabytes: 1, ... }, { Name: "bar.txt", Path: "files/temp/bar.txt", SizeInMegabytes: 2, ... }]

| | Error : `Error` |

Error that occurred during task execution.
Example: object { string Message, Exception AdditionalInfo }

| | {% endtab %} | | {% tab title="Changelog" %} ## Changelog ### \[2.0.0] - 2026-04-08 #### Added * New connection parameters that defined what servers Operating System. * \[Breaking Change] Introduce PathString type that will represent paths with OS specific separators. ### \[1.0.0] - 2025-11-07 #### Added * Initial implementation {% endtab %} {% endtabs %}