. DirectXtras Home
        Home

DirectCommunication Xtra
DirectConnection Xtra
DirectControl Xtra
DirectEmail Xtra
DirectFTP Xtra
DirectImage Xtra
DirectInteraction Xtra
DirectOS Xtra
Documentation
License Agreement
Licensing Fees
Order Form
DirectSMS Xtra
DirectSound Xtra
DirectTransition Xtra
DirectTransition3D Xtra Set I
DirectTransition3D Xtra Set II
DirectTransition3D Xtra Set III
DirectTTS Xtra
XtrAgent
DirectXport Xtra

SpeechPlugin

Special Discounted Bundles

The Gallery
How To Order
Order Form
Check for Upgrades

Sign in
Change Your Profile

Contact Us
















    .
DirectXtras
Xtra Power for Director & Authorware



DirectOS Xtra
 Directing Windows and MacOS. The OS at your fingertips!

Authorware 4.x Compatible Authorware 5.x CompatibleAuthorware 6.x CompatibleAuthorware 7.x CompatibleDirector 5.x Compatible Director 6.x CompatibleDirector 7.x Compatible Director 8.x CompatibleDirector MX Compatible     MacOS 8.x and 9.x CompatibleMacOS X CompatibleWindows Compatible   

dosGetSpecialFolder(string Folder)

Returns the pathname of the special folder indicated by the Folder parameter. Some values for the Folder parameter are valid for Windows and MacOS, some are valid for Windows only and some are valid for MacOS only. 

Parameter :

Folder : A string specifying which special folder to return the pathname of. This parameter is case insensitive. 
Possible Values For Windows And MacOS :
"OS" : Returns the operating system folder location. For example, "C:\WINNT\" on Windows or "My Mac:System Folder:" on MacOS. On MacOS this is exactly the same as passing "SYSTEM".
"SYSTEM" : Returns the operating system's system folder location. For example, "C:\WINNT\System32\" on Windows or "My Mac:System Folder:" on MacOS. On MacOS this is exactly the same as passing "OS".
"TEMP" :  Returns the temporary folder location. For example, "C:\TEMP\" on Windows or "My Mac:Temporary Items:" on MacOS. If the temporary folder does not exist the function will automatically create one.
"DESKTOP" : Returns the desktop folder location. For example, "C:\Documents and Settings\username\Desktop\" on Windows or "My Mac:Desktop Folder:" on MacOS.
"FONTS" : Returns the fonts folder location. For example, "C:\WINNT\Fonts\" on Windows or "My Mac:System Folder:Fonts:" on MacOS.
"STARTUP" : Returns the start up items folder location. For example, "C:\Documents and Settings\username\Start Menu\Programs\Startup\" on Windows or "My Mac:System Folder:Startup Items:" on MacOS.
"RECENT" : Returns the recent documents folder location. For example, "C:\Documents and Settings\username\Recent\" on Windows or "My Mac:System Folder:Apple Menu Items:Recent Documents:" on MacOS.
"DOCUMENTS" : Returns the personal documents folder location. For example, "C:\Documents and Settings\username\My Documents\" on Windows or  "My Mac:Documents:" on MacOS.
"PROGRAM FILES" : Returns the program files folder location. For example, "C:\Program Files\" on Windows or "My Mac:Applications:" on MacOS.
"PRINTER DESCRIPTIONS" : Returns the printhood folder location on Windows (used to store printer links) or the printer descriptions folder location on MacOS. For example, "C:\Documents and Settings\username\PrintHood\" on Windows or "My Mac:System Folder:Extensions:Printer Descriptions:" on MacOS. This feature is not available on Windows 9X.
"APPLICATION SUPPORT" : Returns the application support folder location. For example, "C:\Documents and Settings\username\Application Data\" on Windows or  "My Mac:System Folder:Application Support:" on MacOS. On Windows, this feature requires that Microsoft Internet Explorer version 4.0 or later will be installed.
"START MENU" :
Returns the start menu folder location on Windows or the Apple Menu Items folder location on MacOS. A typical path is "C:\Documents and Settings\username\Start Menu\" on Windows or "My Mac :System Folder:Apple Menu Items:" on MacOS.

Possible Values For Windows Only :
"FAVORITES" :
Returns the favorites folder location. For example, "C:\Documents and Settings\username\Favorites\".
"GROUPS" :
Returns the folder that contains the user's program groups (which are also file system folders). A typical path is "C:\Documents and Settings\username\Start Menu\Programs\".
"SENDTO" : Returns the send to folder location. For example, "C:\Documents and Settings\username\SendTo\".  
"TEMPLATES" : Returns the new documents template folder location. For example "C:\Documents and Settings\username\Templates\".
"COMMON DESKTOP" : Returns the common desktop folder location. For example, "C:\Documents and Settings\All Users\Desktop\". This feature is not available on Windows 9X.
"COMMON GROUPS" : Returns the common groups folder location. For example, " C:\Documents and Settings\All Users\Start Menu\Programs\". This feature is not available on Windows 9X.
"COMMON START MENU" : Returns the common start menu folder location. For example, "C:\Documents and Settings\All Users\Start Menu\". This feature is not available on Windows 9X.
"NETHOOD" : Returns the nethood folder location (used to hold objects appearing in Network Neighborhood). For example, "C:\Documents and Settings\username\NetHood\". This feature is not available on Windows 9X.
"COMMON APPLICATION SUPPORT" :
Returns the common application data folder location. For example, "C:\Documents and Settings\All Users\Application Data\". This feature is only available on Windows 2000, Me, XP, and later.
"COMMON DOCUMENTS" : Returns the common documents folder location. For example, "C:\Documents and Settings\All Users\Documents\". This feature is not available on Windows 9X.
"COMMON FAVORITES" : Returns the common favorites folder location. For example, "C:\Documents and Settings\All Users\Favorites\". This feature is not available on Windows 9X.
"COMMON STARTUP" : Returns the common startup folder location. For example, "C:\Documents and Settings\All Users\Start Menu\Programs\Startup\". This feature is not available on Windows 9X.
"COMMON TEMPLATES" : Returns the common templates folder location. For example, "C:\Documents and Settings\All Users\Templates\". This feature is not available on Windows 9X.
"COMMON PROGRAM FILES" : Returns the common program files folder location. For example, "C:\Program Files\Common Files\". This feature is only available on Windows 2000, Me, XP, and later.
"COOKIES" :
Returns the folder location of where cookies are stored. For example, "C:\Documents and Settings\username\Cookies\". This feature is not available on Windows 9X.
"MY PICTURES" : Returns the My Pictures folder location. For example, "C:\Documents and Settings\username\My Documents\My Pictures\". This feature is only available on Windows 2000, Me, XP, and later.

Possible Values For MacOS Only :

"TRASH" : Returns the trash folder location. For example, "My Mac:Trash:". 
"PREFS" : Returns the preferences folder location. For example, "My Mac:System Folder:Preferences:".
"CONTROL PANELS" : Returns the control panels folder location. For example, "My Mac :System Folder:Control Panels:". This feature is only available on MacOS classic.
"EXTENSIONS" : Returns the preferences folder location. For example, "My Mac :System Folder:Extensions:". This feature is only available on MacOS classic.
"PRINT MONITOR" : Returns the print monitor folder location. For example, "My Mac:System Folder:PrintMonitor Documents:". This feature is only available on MacOS classic.

Return Value : The pathname of the special folder indicated by the Folder parameter. If the value of the Folder parameter is not recognized as a valid parameter value, an empty string is returned. If the pathname cannot be determined, an empty string is returned. The returned string will always end with a colon (MacOS path separator) or a backslash (Windows path separator). If an empty string is returned, dosGetLastError() should be called to determine the cause of the error. 

Possible Returned Error Codes via dosGetLastError() :
10001 : Invalid value for parameter 1. 
10031 : Folder was not found.



DirectXtras Inc.
P.O Box 2645, Menlo Park, CA, 94026, U.S.A
Voice: +1-415-5058249, Fax: +1-801-8585841
Toll Free: 1-800-4453093
E-mail General Information: info@directxtras.com
E-mail Technical Support: support@directxtras.com

Copyright 1996-2004 DirectXtras Inc. All Rights Reserved.
WebMaster: tamar@directxtras.com
Last Updated: 12/19/2002 3:43:05 AM.