Difference between revisions of "Lua:getFileList"
Jump to navigation
Jump to search
(Created page with "getFileList(Path:string, searchMask:string OPTIONAL, SearchSubDirs: boolean OPTIONAL, DirAttrib: integer OPTIONAL): Returns an indexed table with filenames <pre> r = getFileLi...") |
m |
||
| Line 1: | Line 1: | ||
| − | getFileList(Path | + | [[Category:Lua]] |
| + | '''function''' getFileList(''Path'', [''SearchMask''], [''SearchSubDirs''], [''DirAttrib'']) ''':''' Table | ||
| + | |||
| + | Returns an indexed table containing the names of files in the specified path. | ||
| + | |||
| + | ===Function Parameters=== | ||
| + | {|width="85%" cellpadding="10%" cellspacing="0" border="0" | ||
| + | !align="left"|Parameter | ||
| + | !align="left"|Type | ||
| + | !style="width: 80%;background-color:white;" align="left"|Description | ||
| + | |- | ||
| + | |Path | ||
| + | |String | ||
| + | |The directory path to search. | ||
| + | |- | ||
| + | |SearchMask | ||
| + | |String (optional) | ||
| + | |A file mask (e.g., <code>"*.exe"</code>) to filter results. Default is <code>"*"</code>. | ||
| + | |- | ||
| + | |SearchSubDirs | ||
| + | |Boolean (optional) | ||
| + | |If true, searches subdirectories recursively. Default is false. | ||
| + | |- | ||
| + | |DirAttrib | ||
| + | |Integer (optional) | ||
| + | |Directory attribute filter. Default is 0. | ||
| + | |} | ||
| + | |||
| + | ===Returns=== | ||
| + | Table — An indexed table with the names of files found. | ||
| + | |||
| + | ===Examples=== | ||
<pre> | <pre> | ||
| − | + | local files = getFileList(getAutorunPath(), "*.txt") | |
| − | + | for i, name in ipairs(files) do | |
| − | + | print(name) | |
| − | + | end | |
| − | + | ||
| − | + | -- Search recursively for all .dll files | |
| − | + | local dlls = getFileList(getAutorunPath(), "*.dll", true) | |
| − | + | for i, name in ipairs(dlls) do | |
| − | + | print(name) | |
| − | + | end | |
| − | |||
</pre> | </pre> | ||
| + | |||
| + | == See also == | ||
| + | * [[getDirectoryList]] | ||
Revision as of 19:16, 11 July 2025
function getFileList(Path, [SearchMask], [SearchSubDirs], [DirAttrib]) : Table
Returns an indexed table containing the names of files in the specified path.
Function Parameters
| Parameter | Type | Description |
|---|---|---|
| Path | String | The directory path to search. |
| SearchMask | String (optional) | A file mask (e.g., "*.exe") to filter results. Default is "*".
|
| SearchSubDirs | Boolean (optional) | If true, searches subdirectories recursively. Default is false. |
| DirAttrib | Integer (optional) | Directory attribute filter. Default is 0. |
Returns
Table — An indexed table with the names of files found.
Examples
local files = getFileList(getAutorunPath(), "*.txt") for i, name in ipairs(files) do print(name) end -- Search recursively for all .dll files local dlls = getFileList(getAutorunPath(), "*.dll", true) for i, name in ipairs(dlls) do print(name) end
