Skip to content

GetWindowsSpecialDir

Get the location of a special directory.

Declaration

Source position: windirs.pp line 223

  function GetWindowsSpecialDir(ID: Integer; CreateIfNotExists: Boolean)
                                : string;
  function GetWindowsSpecialDir(const GUID: TGuid; 
                               CreateIfNotExists: Boolean) : string;

Description

GetWindowsSpecialDir can be used to to get the path of special folders on the Windows system. The locations are identified using one of the CSIDL_* constants. If the ID of a location is or-ed with the CSIDL_FLAG_CREATE constant, then the directory will be created if it didn't exist yet (and the user has sufficient rights to do so).

Errors

On error, an empty string is returned.