Tutorial

Getting Started with Macros

Macro Editor

User Interface

Menus and Toolbar

Editing Macros

Macro Debugging

How To

Using variables

Finding and modifying objects

Creating new page content

Asking for user input

Storing persistent data

Using binary data

Sorting objects

Macro menus

Bulleted and numbered lists

Accessing the file system

Sample Macros

Concepts

Expressions

Objects

Properties

Variables

Data Types

Arrays

Functions

Literals

Operators

Comments

Last updated on: February 02, 2025
Also available as a single HTML file

Onetastic Macro Documentation > Functions > File System Functions > FileSystem_GetKnownFolder

FileSystem_GetKnownFolder

Returns the requested known folder. Such folders are the current users's Desktop, Downloads, Documents, and Pictures folder, as well as the system's Temp folder.

Syntax

Folder FileSystem_GetKnownFolder(String knownFolder)

Parameters

String knownFolder
The identifier for the known folder. Possible values are: desktop, downloads, documents, pictures, temp.

Examples

// Get the user's desktop folder $folder = FileSystem_GetKnownFolder("desktop") if (IsObject($folder)) // Folder is found

Reference

Statements

Hierarchy Objects

Page Objects

Other Objects

Functions

Array Functions

Color Functions

Data Store Functions

Date/Time Functions

Dialog Box Functions

File System Functions

Macro Execution Functions

Macro Menu Functions

Object Functions

Special Functions

String Functions

Window Functions