DIR$: Difference between revisions
Jump to navigation
Jump to search
Navigation:
Main Page with Articles and Tutorials
Keyword Reference - Alphabetical
Keyword Reference - By usage
Report a broken link
No edit summary |
(Add info on v3.11.0 update) |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:_DIR$}} | {{DISPLAYTITLE:_DIR$}} | ||
The [[_DIR$]] function returns common paths | The [[_DIR$]] function returns common paths such as Documents, Pictures, Music, Desktop, etc. | ||
| Line 8: | Line 8: | ||
{{PageParameters}} | {{PageParameters}} | ||
* ''folderspecification'' may be "desktop", " | * ''folderspecification'' may be "desktop", "downloads", "documents", "music", "video", "pictures", "appdata", "common program data", "local data", "program files", "program files (x86)", "temp", "home", "fonts", "user fonts". | ||
* Some variation is accepted for the folder specification: | * Some variation is accepted for the folder specification: | ||
:: MY DOCUMENTS, TEXT, DOCUMENT, DOCUMENTS, DOWNLOAD, DOWNLOADS | :: MY DOCUMENTS, TEXT, DOCUMENT, DOCUMENTS, DOWNLOAD, DOWNLOADS | ||
| Line 15: | Line 15: | ||
:: MY VIDEOS, VIDEO, VIDEOS, MOVIE, MOVIES, | :: MY VIDEOS, VIDEO, VIDEOS, MOVIE, MOVIES, | ||
:: DATA, APPDATA, APPLICATION DATA, PROGRAM DATA, LOCAL DATA, LOCALAPPDATA, LOCAL APPLICATION DATA, LOCAL PROGRAM DATA | :: DATA, APPDATA, APPLICATION DATA, PROGRAM DATA, LOCAL DATA, LOCALAPPDATA, LOCAL APPLICATION DATA, LOCAL PROGRAM DATA | ||
:: PROGRAMFILES, PROGRAMFILESX86, PROGRAMFILES X86, PROGRAM FILES X86, PROGRAM FILES 86, PROGRAMFILES (X86), PROGRAM FILES(X86), PROGRAMFILES(X86) | |||
:: FONT, USERFONT, USERFONTS, USER FONT | |||
:: USER, PROFILE, USERPROFILE, USER PROFILE | |||
{{PageDescription}} | {{PageDescription}} | ||
* The path returned ends with a backslash | * The path returned ends with a backslash on Windows and a forward-slash on Linux and macOS. | ||
* A nonexistent folder specification usually defaults to the Desktop folder path. | * A nonexistent folder specification usually defaults to the Desktop folder path. | ||
* In | |||
{{PageAvailability}} | |||
<!-- QB64 = a version or none, QBPE = a version or all, Platforms = yes or no --> | |||
<gallery widths="48px" heights="48px" mode="nolines"> | |||
File:Qb64.png|'''all''' | |||
File:Qbpe.png|'''all''' | |||
File:Apix.png | |||
File:Win.png|'''yes''' | |||
File:Lnx.png|'''yes''' | |||
File:Osx.png|'''yes''' | |||
</gallery> | |||
<!-- additional availability notes go below here --> | |||
* In '''QB64-PE v3.11.0''' support for "font" & "user font" and full Linux and macOS support was added. | |||
{{PageExamples}} | {{PageExamples}} | ||
Example: Displaying default paths in Windows | Example: Displaying default paths in Windows. | ||
{{CodeStart}} | {{CodeStart}} | ||
{{Cl|PRINT}} {{Text|<nowiki>"DESKTOP="</nowiki>|#FFB100}} + {{Cl|_DIR$}}({{Text|<nowiki>"desktop"</nowiki>|#FFB100}}) | {{Cl|PRINT}} {{Text|<nowiki>"DESKTOP="</nowiki>|#FFB100}} + {{Cl|_DIR$}}({{Text|<nowiki>"desktop"</nowiki>|#FFB100}}) | ||
Revision as of 22:34, 2 January 2024
The _DIR$ function returns common paths such as Documents, Pictures, Music, Desktop, etc.
Syntax
- d$ = _DIR$("folderspecification")
Parameters
- folderspecification may be "desktop", "downloads", "documents", "music", "video", "pictures", "appdata", "common program data", "local data", "program files", "program files (x86)", "temp", "home", "fonts", "user fonts".
- Some variation is accepted for the folder specification:
- MY DOCUMENTS, TEXT, DOCUMENT, DOCUMENTS, DOWNLOAD, DOWNLOADS
- MY MUSIC, MUSIC, AUDIO, SOUND, SOUNDS
- MY PICTURES, PICTURE, PICTURES, IMAGE, IMAGES, PHOTO, PHOTOS, DCIM, CAMERA, CAMERA ROLL
- MY VIDEOS, VIDEO, VIDEOS, MOVIE, MOVIES,
- DATA, APPDATA, APPLICATION DATA, PROGRAM DATA, LOCAL DATA, LOCALAPPDATA, LOCAL APPLICATION DATA, LOCAL PROGRAM DATA
- PROGRAMFILES, PROGRAMFILESX86, PROGRAMFILES X86, PROGRAM FILES X86, PROGRAM FILES 86, PROGRAMFILES (X86), PROGRAM FILES(X86), PROGRAMFILES(X86)
- FONT, USERFONT, USERFONTS, USER FONT
- USER, PROFILE, USERPROFILE, USER PROFILE
Description
- The path returned ends with a backslash on Windows and a forward-slash on Linux and macOS.
- A nonexistent folder specification usually defaults to the Desktop folder path.
Availability
all
all
yes
yes
yes
- In QB64-PE v3.11.0 support for "font" & "user font" and full Linux and macOS support was added.
Examples
Example: Displaying default paths in Windows.
PRINT "DESKTOP=" + _DIR$("desktop") PRINT "DOWNLOADS=" + _DIR$("download") PRINT "DOCUMENTS=" + _DIR$("my documents") PRINT "PICTURES=" + _DIR$("pictures") PRINT "MUSIC=" + _DIR$("music") PRINT "VIDEO=" + _DIR$("video") PRINT "APPLICATION DATA=" + _DIR$("data") PRINT "LOCAL APPLICATION DATA=" + _DIR$("local application data") |
DESKTOP=C:\Documents and Settings\Administrator\Desktop\ DOWNLOADS=C:\Documents and Settings\Administrator\Downloads\ DOCUMENTS=C:\Documents and Settings\Administrator\My Documents\ PICTURES=C:\Documents and Settings\Administrator\My Documents\My Pictures\ MUSIC=C:\Documents and Settings\Administrator\My Documents\My Music\ VIDEO=C:\Documents and Settings\Administrator\My Documents\My Videos\ APPLICATION DATA=C:\Documents and Settings\Administrator\Application Data\ LOCAL APPLICATION DATA=C:\Documents and Settings\Administrator\Local Settings\Application Data\ |
See also