Lua:getFileList - Revision history

Leunsel: Major overhaul of the post.

2026-06-27T00:50:58Z

Major overhaul of the post.

Leunsel: Syntax Highlighting.

2026-06-25T19:23:53Z

Syntax Highlighting.

Leunsel at 19:16, 11 July 2025

2025-07-11T19:16:18Z

Leunsel at 19:16, 11 July 2025

2025-07-11T19:16:03Z

Ajanuw: Created page with "getFileList(Path:string, searchMask:string OPTIONAL, SearchSubDirs: boolean OPTIONAL, DirAttrib: integer OPTIONAL): Returns an indexed table with filenames

 r = getFileLi..."

2020-08-21T06:28:13Z

Created page with "getFileList(Path:string, searchMask:string OPTIONAL, SearchSubDirs: boolean OPTIONAL, DirAttrib: integer OPTIONAL): Returns an indexed table with filenames <pre> r = getFileLi..."

New page

getFileList(Path:string, searchMask:string OPTIONAL, SearchSubDirs: boolean OPTIONAL, DirAttrib: integer OPTIONAL): Returns an indexed table with filenames
<pre>
r = getFileList("C:\\CE\\autorun", "*.DLL", true)
require 'pl.pretty'.dump(r)
</pre>
Print result:
<pre>
{
"C:\\CE\\autorun\\dlls\\MonoDataCollector32.dll",
"C:\\CE\\autorun\\dlls\\MonoDataCollector64.dll",
"C:\\CE\\autorun\\dlls\\32\\CEJVMTI.dll",
"C:\\CE\\autorun\\dlls\\64\\CEJVMTI.dll"
}
</pre>

@@ Line 1: / Line 1: @@
 [[Category:Lua]]
-'''function''' getFileList(''Path'', [''SearchMask''], [''SearchSubDirs''], [''DirAttrib'']) ''':''' Table
+{{CodeBox|'''function''' getFileList(''path'', ''searchMask'' OPTIONAL, ''searchSubDirs'' OPTIONAL, ''dirAttrib'' OPTIONAL) ''':''' table}}
-Returns an indexed table containing the names of files in the specified path.
+Returns an indexed Lua table containing filenames from the specified path.
 ===Function Parameters===
@@ Line 10: / Line 12: @@
 !style="width: 80%;background-color:white;" align="left"|Description
 |-
-|Path
+|path
 |String
-|The directory path to search.
+|The directory path to search in.
 |-
-|SearchMask
+|searchMask
-|String (optional)
+|String OPTIONAL
-|A file mask (e.g., <code>"*.exe"</code>) to filter results. Default is <code>"*"</code>.
+|The filename mask to search for. For example, <code>"*.txt"</code> or <code>"*.*"</code>.
 |-
-|SearchSubDirs
+|searchSubDirs
-|Boolean (optional)
+|Boolean OPTIONAL
-|If true, searches subdirectories recursively. Default is false.
+|If true, subdirectories are searched as well.
 |-
-|DirAttrib
+|dirAttrib
-|Integer (optional)
+|Integer OPTIONAL
-|Directory attribute filter. Default is 0.
+|Optional directory attribute filter.
 |}
 ===Returns===
-Table — An indexed table with the names of files found.
+Table — An indexed Lua table containing the matching filenames.
 ===Examples===
 <syntaxhighlight lang="lua" line>
-local files = getFileList(getAutorunPath(), "*.txt")
+====List all files in a directory====
-for i, name in ipairs(files) do
+<syntaxhighlight lang="lua" line highlight="1">
-   print(name)
+local files = getFileList([[C:\\Temp]])
 end
--- Search recursively for all .dll files
+if #files == 0 then
-local dlls = getFileList(getAutorunPath(), "*.dll", true)
+  print("No matching files found")
-for i, name in ipairs(dlls) do
+else
-  print(name)
+  for i, filename in ipairs(files) do
 end
 </syntaxhighlight>
 {{LuaSeeAlso}}

@@ Line 31: / Line 31: @@
 ===Examples===
-<pre>
+<syntaxhighlight lang="lua" line>
 local files = getFileList(getAutorunPath(), "*.txt")
 for i, name in ipairs(files) do
@@ Line 42: / Line 42: @@
    print(name)
 end
-</pre>
+</syntaxhighlight>
-== See also ==
+{{LuaSeeAlso}}

← Older revision		Revision as of 19:16, 11 July 2025
Line 45:		Line 45:

	== See also ==		== See also ==
−	* [[getDirectoryList]]	+	* [[Lua:getDirectoryList\|getDirectoryList]]

@@ Line 1: / Line 1: @@
-getFileList(Path:string, searchMask:string OPTIONAL, SearchSubDirs: boolean OPTIONAL, DirAttrib: integer OPTIONAL): Returns an indexed table with filenames
+[[Category:Lua]]
 <pre>
-r = getFileList("C:\\CE\\autorun", "*.DLL", true)
+local files = getFileList(getAutorunPath(), "*.txt")
-require 'pl.pretty'.dump(r)
+for i, name in ipairs(files) do
-</pre>
+  print(name)
-Print result:
+end
-<pre>
+-- Search recursively for all .dll files
-  "C:\\CE\\autorun\\dlls\\MonoDataCollector32.dll",
+local dlls = getFileList(getAutorunPath(), "*.dll", true)
-  "C:\\CE\\autorun\\dlls\\MonoDataCollector64.dll",
+for i, name in ipairs(dlls) do
-  "C:\\CE\\autorun\\dlls\\32\\CEJVMTI.dll",
+   print(name)
-   "C:\\CE\\autorun\\dlls\\64\\CEJVMTI.dll"
+end
 </pre>