Filesystem - Open Dev Kit Documentation

Open Dev Kit Documentation :: General :: Filesystem

Root.Filesystem

Provides functions for interacting with the filesystem

Functions

Get Directory ( Path String ) String: Returns the directory portion of a path
Get Filename ( Path String ) String: Returns the filename portion of a path excluding the extension
Get Extension ( Path String ) String: Returns the extension portion of a path including the period
Get Filename And Extension ( Path String ) String: Returns the filename and extension portion of a path
Is Directory ( Path String ) Boolean: Returns if the filename specifies a directory
Get Directory Contents ( Path String, Recursive Boolean, Return Files Boolean, Return Folders Boolean ) String Array: Returns the contents of directory in the specified path
Create Directory ( Path String ): Creates the specified directory tree (recursively)
Temporary Filename ( Extension String ) String: Returns a randomly generated temporary filename
File Exists ( Path String ) Boolean: Returns a true/false value based on whether a file or folder exists
File Size ( Path String ) Long: Returns the size of a file in bytes
File Date Modified ( Path String ) Time: Returns the modified date/time of a file
File Copy ( Source String, Destination String, Overwrite Boolean ) Boolean: Copies a file from location to another
File Rename/Move ( Source String, Destination String ) Boolean: Renames a file or moves it from one location to another
Write File Contents ( Path String, Content String ) Boolean: Creates or overwrites a file with the contents of a string
Read File Contents ( Path String, Offset Integer, Bytes Integer ) String: Returns the entire contents of a file as a string
Write XML Object to File ( Path String, Object Abstract*, Dynamic Type Boolean ) Boolean: Creates or overwrites a file with the contents of a object serialized into an object
Read XML Object from File ( Path String, Type API Node*, Dynamic Type Boolean ) Abstract*: Returns the entire contents of a file as a string
Write Resource to File ( Paths String Array, Resource Resource* ) Boolean: Creates or overwrites files with the contents of a resource
Read Resource from File ( Paths String Array, Type API Node* ) Resource*: Returns a resource that references contents of files
Write Configuration String ( Key String, Value String, Section String, File String ): Stores an option in the application's configration file for the current user
Read Configuration String ( Key String, Default String, Section String, File String ) String: Retrieves a previously stored value in the application's configuration file for the current user
Write Configuration Integer ( Key String, Value Integer, Section String, File String ): Stores an option in the application's configration file for the current user
Read Configuration Integer ( Key String, Default Integer, Section String, File String ) Integer: Retrieves a previously stored value in the application's configuration file for the current user
Open URL ( URL String ): Opens the provided URL in the default web browser

Properties

Root Path String: working directory for the executable
Data Path String: application data folder for the user
Executable Path String: path where the executable is stored

If you think anything is missing, please feel free to: submit documentation feedback on this page