System.IOUtils.TPath.GetSharedDocumentsPath
Delphi
class function GetSharedDocumentsPath: string; static;
C++
static System::UnicodeString __fastcall GetSharedDocumentsPath();
Properties
| Type | Visibility | Source | Unit | Parent |
|---|---|---|---|---|
| function | public | System.IOUtils.pas System.IOUtils.hpp |
System.IOUtils | TPath |
Description
Returns the path to the directory where documents shared between users are stored.
- Note: In desktop applications, "shared" means "shared between different users". In mobile applications, "shared" means "shared between different applications".
If the system running your application does not support the requested folder, or if the requested folder does not exist in the system, this function returns an empty string instead.
- On Windows and Android, it points to a system-wide directory.
- On OS X, it points to a user-specific, application-agnostic directory.
- On iOS Device, an empty string is returned, as shared document folders are not supported.
- On iOS Simulator, it points to an application-specific directory.
| Platform | Sample path | Path ID |
|---|---|---|
| Windows XP | C:\Documents and Settings\All Users\Documents | CSIDL_COMMON_DOCUMENTS |
| Windows Vista or later | C:\Users\Public\Documents | FOLDERID_PublicDocuments |
| OS X | /Users/<username>/Public | NSSharedPublicDirectory |
| iOS Device | ||
| iOS Simulator | /Users/<username>/Library/Developer/CoreSimulator/Devices/<Device ID>/data/Containers/Data/Application/<application ID>/Public | NSSharedPublicDirectory |
| Android | /storage/emulated/0/Documents | Context.getExternalFilesDir |