Difference between revisions of "File to array"

From Kolmafia
Jump to navigation Jump to search
(2 intermediate revisions by the same user not shown)
Line 8: Line 8:
 
|function1.param2.default=
 
|function1.param2.default=
 
|function1.param1.description=Path to the text file
 
|function1.param1.description=Path to the text file
|description=The returned value is actually a map of strings, one string for each line. Like <code>[[file_to_map|file_to_map()]]</code>, empty lines and those starting with a <code>#</code> are ignored.
+
|description=<p>The returned value is actually a map of strings, one string for each line. Like <code>[[file_to_map|file_to_map()]]</code>, empty lines and those starting with a <code>#</code> are ignored.</p>
 +
 
 +
<p>This function was added in [https://kolmafia.us/threads/18740-add-string-int-file_to_array-string-filename.22964/ r18740].</p>
 
|code1={{CodeSample
 
|code1={{CodeSample
 
   |title=Code Samples
 
   |title=Code Samples
Line 21: Line 23:
 
   |moreinfo=
 
   |moreinfo=
 
}}
 
}}
|see_also={{SeeAlso|file_to_map|map_to_file}}
+
|see_also={{SeeAlso|buffer_to_file|file_to_buffer|file_to_map|map_to_file}}
 
|{{{1|}}}
 
|{{{1|}}}
 
}}</onlyinclude>
 
}}</onlyinclude>
 
[[Category:Miscellaneous Functions]]
 
[[Category:Miscellaneous Functions]]

Revision as of 05:34, 21 December 2020

Function Syntax

string [int] file_to_arraystring filename )

Reads data from a text file and returns a map of strings containing each line.
  • filename: Path to the text file

The returned value is actually a map of strings, one string for each line. Like file_to_map(), empty lines and those starting with a # are ignored.

This function was added in r18740.

Code Samples

Reads a data file into a map of strings and prints each line

string [int] lines = file_to_array("mydata.txt");
foreach line_no, line in lines {
  print(`{line_no}: {line}`);
}

See Also

buffer_to_file() | file_to_buffer() | file_to_map() | map_to_file()