| Info |
|---|
|
This routine is available starting with SIL Engine™ 2.5.15 / 2.6.7.| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| heading | 0 |
|---|
| columnTypes | s,s,s,s |
|---|
| multiple | false |
|---|
| columnAttributes | style="background:#e5e7ea;font-weight:bold,,style="background:#e5e7ea;font-weight:bold, |
|---|
| enableSorting | false |
|---|
|
Syntax | findDirectories(directory, regex) | Package | file | Alias | |
...
...
Description
| Excerpt |
|---|
|
| Searches for directories that match the given regex in the specified folder. |
Searches for directories that match the given regex in the specified folder. The routine only searches for directories, not files.
...
Returns a list with absolute paths for directories that match the given regex. The regex match is done on the file name, not the full path. If the regex parameter is empty string, the routine returns an empty result.
Parameters
| Table plus |
|---|
| applyColStyleToCell | true |
|---|
| columnTypes | s,s,s,s |
|---|
| heading | 0 |
|---|
| multiple | false |
|---|
| enableSorting | false |
|---|
|
Parameter name | Type | Required | Description |
|---|
directory | |
...
String | Yes | Specifies the directory to search in. | regex |
|
...
String | Yes | Specifies the file pattern to search for. |
|
Return
...
Type
string String []Returns an array containing the absolute paths of all directories from the given directory which name match the regex.
Example
| Code Block |
|---|
findDirectories("C:/JIRA/plugins", "kepler.*");
|
Results: An array containing all absolute paths for folders starting with 'kepler' from the folder C:\JIRA\plugins.
...
| Note |
|---|
- It is recommended that you use forward slashes ( / ) for file paths.
- If the regex contains a backslash replace it with two backslashes otherwise you will get a syntax error.
|
See also
| Filter by label (Content by label) |
|---|
| showLabels | false |
|---|
| max | 25 |
|---|
| showSpace | false |
|---|
| cql | label = "file_routines" and space = currentSpace ( ) |
|---|
| labels | filearray_routines |
|---|
|