files

Method Maps2

Symbol	Description
DirectoryListing	A DirectoryListing iterates over the contents of a directory. To obtain a DirectoryListing handle, call OpenDirectory().
File	A File object can be obtained by calling OpenFile(). File objects should be closed with delete or Close(). Note that, "delete file" does not actually delete the file, it just closes the handle.

Enumerations4

Symbol	Description
FileOpResult	Results reported by asynchronous filesystem operations.
FileTimeMode	File time modes.
FileType	File inode types.
PathType	Path types.

Type Definitions5

Symbol	Description
FileDirectoryCallback	Called when an asynchronous directory snapshot has been materialized. On success, listing contains a fully-materialized DirectoryListing and must be closed by the callback. It is independent of later filesystem changes. On failure, listing is null.
FileExistsCallback	Called when an asynchronous existence check completes.
FileOpCallback	Called when an asynchronous filesystem operation completes.
FileReadCallback	Called when an asynchronous whole-file read completes. contents contains the raw file bytes. It is binary-safe, including embedded NUL bytes, and its length is given by size. Do not use string-focused natives on it unless the data is known to be a string.
FileSizeCallback	Called when an asynchronous file-size query completes.

Defines13

Symbol	Description
FPERM_G_EXEC	Group can exec.
FPERM_G_READ	Group can read.
FPERM_G_WRITE	Group can write.
FPERM_O_EXEC	Anyone can exec.
FPERM_O_READ	Anyone can read.
FPERM_O_WRITE	Anyone can write.
FPERM_U_EXEC	User can exec.
FPERM_U_READ	User can read.
FPERM_U_WRITE	User can write.
PLATFORM_MAX_PATH	Maximum path length.
SEEK_CUR	Seek from current position.
SEEK_END	Seek from end position.
SEEK_SET	Seek from start.

Functions40

Symbol	Description
BuildPath	Builds a path relative to the SourceMod folder. This should be used instead of directly referencing addons/sourcemod, in case users change the name of their folder layout.
CopyFile	Copies a file. If the destination file already exists, it is overwritten.
CopyFileAsync	Copies a file without blocking the game thread. Existing destinations are overwritten.
CreateDirectory	Creates a directory.
CreateDirectoryAsync	Creates a directory without blocking the game thread.
DeleteFile	Deletes a file.
DeleteFileAsync	Deletes a file without blocking the game thread.
DirExists	Checks if a directory exists.
DirExistsAsync	Checks for a directory without blocking the game thread.
FileExists	Checks if a file exists.
FileExistsAsync	Checks for a regular file without blocking the game thread.
FilePosition	Get current position in the file.
FileSeek	Sets the file position indicator.
FileSize	Get the file size in bytes.
FileSizeAsync	Gets a file's size without blocking the game thread.
FlushFile	Flushes a file's buffered output; any buffered output is immediately written to the file.
GetFilePermissions	Retrieves a file or directories permissions.
GetFileTime	Returns a file timestamp as a unix timestamp.
IsEndOfFile	Tests if the end of file has been reached.
LogToOpenFile	Same as LogToFile(), except uses an open file Handle. The file must be opened in text appending mode.
LogToOpenFileEx	Same as LogToFileEx(), except uses an open file Handle. The file must be opened in text appending mode.
OpenDirectory	Opens a directory/folder for contents enumeration.
OpenDirectoryAsync	Enumerates an OS filesystem directory without blocking the game thread. The callback receives a fully-materialized DirectoryListing snapshot.
OpenFile	Opens or creates a file, returning a File handle on success. File handles should be closed with delete or CloseHandle(). The open mode may be one of the following strings: "r": Open an existing file for reading. "w": Create a file for writing, or truncate (delete the contents of) an existing file and then open it for writing. "wx": Create file for writing, fails if file already exists. "a": Create a file for writing, or open an existing file such that writes will be appended to the end. "r+": Open an existing file for both reading and writing. "w+": Create a file for reading and writing, or truncate an existing file and then open it for reading and writing. "a+": Create a file for both reading and writing, or open an existing file such that writes will be appended to the end. The open mode may also contain an additional character after "r", "w", or "a", but before the "+" sign. This character may be "b" (indicating binary mode) or "t" (indicating text mode). By default, "text" mode is implied. On Linux and Mac, this has no distinction from binary mode. On Windows, it causes the '\n' character (0xA) to be written as "\r\n" (0xD, 0xA). Example: "rb" opens a binary file for reading; "at" opens a text file for appending.
ReadDirEntry	Reads the current directory entry as a local filename, then moves to the next file.
ReadFile	Reads binary data from a file.
ReadFileAsync	Reads a whole file without blocking the game thread.
ReadFileCell	Reads a single binary cell from a file.
ReadFileLine	Reads a line from a text file.
ReadFileString	Reads a UTF8 or ANSI string from a file.
RemoveDir	Removes a directory.
RemoveDirectoryAsync	Removes an empty OS filesystem directory without blocking the game thread.
RenameFile	Renames a file.
RenameFileAsync	Renames a file without blocking the game thread.
SetFilePermissions	Changes a file or directories permissions.
WriteFile	Writes binary data to a file.
WriteFileAsync	Writes size raw bytes from contents without blocking the game thread.
WriteFileCell	Writes a single binary cell to a file.
WriteFileLine	Writes a line of text to a text file. A newline is automatically appended.
WriteFileString	Writes a binary string to a file.