System.SysUtils.GetHomePath

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function GetHomePath: string;

C++

extern DELPHI_PACKAGE System::UnicodeString __fastcall GetHomePath(void)/* overload */;

Properties

Type Visibility Source Unit Parent
function public
System.SysUtils.pas
System.SysUtils.hpp
System.SysUtils System.SysUtils

Description

Returns the path to the home of application's writable scratch directory or storage. Note: Do not use this method for new development. In particular, if you are doing multi-device development, we recommend that you use the more platform-agnostic implementation, System.IOUtils.TPath.GetHomePath.

Specifically, System.SysUtils.GetHomePath returns the current user's AppData folder on Windows, and returns the path to the current user's home directory on OS X. On iOS, GetHomePath returns the iOS app's local directory, which is individually defined for each instance and each iOS device.

You can use GetHomePath to store user-specific files for your application.

See Also