System.IOUtils.TPath.GetSharedAlarmsPath

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

class function GetSharedAlarmsPath: string; static;

C++

static System::UnicodeString __fastcall GetSharedAlarmsPath();

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 user shared alarm sound files 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.

This function works the same as GetSharedMusicPath except for the Android platform, where it returns the path to the folder where Android stores alarm sound files.

  • 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, it returns an empty string as this directory is currently 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\My Music CSIDL_COMMON_MUSIC
Windows Vista or later C:\Users\Public\Music FOLDERID_PublicMusic
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/Alarms Environment.DIRECTORY_ALARMS

See Also