Lua:createFileStream

<> Lua API Reference

function createFileStream(filename, mode) : FileStream

Creates a stream backed by a file.

Use fmCreate, fmOpenRead, fmOpenWrite, or fmOpenReadWrite as the base mode. Sharing flags can be combined with the mode.

Function Parameters

Parameter	Type	Description
filename	String	Path of the file to create or open.
mode	Integer	File mode constant, optionally combined with a sharing flag.

Returns

FileStream — The opened file stream.

Examples

local stream = createFileStream("C:\\Temp\\output.bin", fmCreate)
stream.writeByte(0x42)
stream.destroy()

Main Pages

Core Lua documentation entry points

◆ Lua
◆ Script Engine