Function

Summary

Gets the path of a special folder on a Windows machine.

Package

system

Signature

get-folder-path what &key create => result

Arguments

what

One of :appdata , :documents , :my-documents , :common-appdata , :common-documents or :local-appdata .

create

A boolean.

Values

result

A string naming the path, or nil .

Description

The function get-folder-path obtains the current value for various special folders often used by Windows applications. It is useful because these paths may differ between versions of the operating system. get-folder-path is implemented only on Windows.

what indicates the purpose of the special folder. For instance, :common-appdata means the folder containing application data for all users.

If the folder does not exist and create is true, the folder is created. The default value of create is nil .

If the folder does exist, result is nil .

See also

get-user-profile-directory