# getspecialfolder

Retrieves the path of a special folder.

## Format

    getspecialfolder <strvar> <foldertype>

## Remarks

Stores a Windows special folder to the <strvar> string variable.

## Parameters

string variable <strvar>
  Returns into the got string.
string <foldertype>
  The drive and path of the specified folder by the string <foldertype> stores into the <strvar> string variable.

  AllUsersDesktop | directory that contains files and folders that appear on the desktop for all users
  AllUsersStartMenu | directory that contains the programs and folders that appear on the Start menu for all users
  AllUsersPrograms | directory that contains the directories for the common program groups that appear on the Start menu for all users
  AllUsersStartup | directory that contains the programs that appear in the Startup folder for all users
  Desktop | virtual folder that represents the Windows desktop
  Favorites | directory that serves as a common repository for the user's favorite items
  Fonts | virtual folder that contains fonts
  MyDocuments | virtual folder that represents the My Documents desktop item
  NetHood | directory that contains the link objects that may exist in the My Network Places virtual folder
  PrintHood | directory that contains the link objects that can exist in the Printers virtual folder
  Programs | directory that contains the user's program groups
  Recent | directory that contains shortcuts to the user's most recently used documents
  SendTo | directory that contains Send To menu items
  StartMenu | directory that contains Start menu items
  Startup | directory that corresponds to the user's Startup program group
  Templates | directory that serves as a common repository for document templates

  cf. CSIDL(MSDN library)

## Return Value

System variable <result>
  When the command fails, 0 is stored.
  When the command succeeds, 1 is stored.

## Example

    getspecialfolder str "Desktop"
    if result then
    	messagebox str "Desktop"   ; C:\Documents and Settings\user\desktop
    endif