PathInfo Class Reference

API published in: S60 2nd Ed

Link against: platformenv.lib

Capability Information

Required Capabilities

None

#include <pathinfo.h>

Detailed Description

Class holds information of system paths.

Platform Environment API provides interface for quering system paths. Methods provided by the API should be used instead of hard coded path names. All paths have the trailing backslash included. The API consist of the PathInfo class, DriveInfo class and system paths are defined in PathConfiguration.hrh. The DriveInfo class is defined in DriveInfo.h.

Usage:

  #include <PathInfo.h>

  // Get the root path of Phone Memory.
  TFileName path = PathInfo::PhoneMemoryRootPath();

  // Get the games path and append the path to the root path of Phone Memory.
  path.Append( PathInfo::GamesPath() );

  // 'path' contains now the games path in Phone Memory.

Error handling:

The panic mechanism is used to handle programming errors. GetPath(TInt aPath) method will panic if invalid parameter is given as input. The panic category is named PATHINFO and panic code is:

EInvalidParameter = 0 (Invalid parameter.)


Public Types
enum	TSystemPaths { ENotSystemPath = -1, ERomRootPath = 0, EPhoneMemoryRootPath, EMemoryCardRootPath, EGamesPath, EInstallsPath, EOthersPath, EVideosPath, EImagesPath, EGsmPicturesPath, EMmsBackgroundImagesPath, EPresenceLogosPath, ESoundsPath, EDigitalSoundsPath, ESimpleSoundsPath, EImagesThumbnailPath, EMemoryCardContactsPath }
	Enumeration System Paths defines values to be used for the aPath parameter in GetPath and GetFullPath methods. More...
Static Public Member Functions
static IMPORT_C const TDesC &	RomRootPath ()
	This method returns the root path in ROM.
static IMPORT_C const TDesC &	PhoneMemoryRootPath ()
	This method returns the root path in Phone Memory.
static IMPORT_C const TDesC &	MemoryCardRootPath ()
	This method returns the root path in Memory Card.
static IMPORT_C const TDesC &	GamesPath ()
	This method returns the games path to be appended to a root path.
static IMPORT_C const TDesC &	InstallsPath ()
	This method returns the installs path to be appended to a root path.
static IMPORT_C const TDesC &	OthersPath ()
	This method returns the others path to be appended to a root path.
static IMPORT_C const TDesC &	VideosPath ()
	This method returns the videos path to be appended to a root path.
static IMPORT_C const TDesC &	ImagesPath ()
	This method returns the images path to be appended to a root path.
static IMPORT_C const TDesC &	PicturesPath ()
	This method returns the pictures path to be appended to a root path.
static IMPORT_C const TDesC &	GmsPicturesPath ()
	This method returns the GMS pictures path to be appended to a root path.
static IMPORT_C const TDesC &	MmsBackgroundImagesPath ()
	This method returns the MMS background images path to be appended to a root path.
static IMPORT_C const TDesC &	PresenceLogosPath ()
	This method returns the presence logos path to be appended to a root path.
static IMPORT_C const TDesC &	SoundsPath ()
	This method returns the sounds path to be appended to a root path.
static IMPORT_C const TDesC &	DigitalSoundsPath ()
	This method returns the digital sounds path to be appended to a root path.
static IMPORT_C const TDesC &	SimpleSoundsPath ()
	This method returns the simple sounds path to be appended to a root path.
static IMPORT_C const TDesC &	ImagesThumbnailPath ()
	This method returns a thumbnail images path.
static IMPORT_C const TDesC &	MemoryCardContactsPath ()
	This method returns the full path of the contacts folder in the memory card.
static IMPORT_C const TDesC &	GetPath (TInt aPath)
	This method returns the requested system path.
static IMPORT_C TInt	GetRootPath (TDes &aRootPath, TInt aDrive)
	This method gets the root path of the requested drive.
static IMPORT_C TInt	GetFullPath (TDes &aFullPath, TInt aDrive, TInt aPath)
	This method gets the full path of the requested system path in the requested drive.
static IMPORT_C TInt	PathType (const TDesC &aFullPath)
	This method returns the system path type of the given path.
static IMPORT_C CDesCArray *	GetListOfPathsLC (TInt aDrive)
	This method gets the list of full system paths in the requested drive and leaves the returned pointer in cleanup stack.
static IMPORT_C CDesCArray *	GetListOfPathsL (TInt aDrive)
	This method gets the list of full system paths in the requested drive.

Member Enumeration Documentation

enum PathInfo::TSystemPaths

Enumeration System Paths defines values to be used for the aPath parameter in GetPath and GetFullPath methods.

Enumerator:

ENotSystemPath	This value is used only as a return value of PathType() to indicate that the path is not a system path. It is not a valid system path to be given as a parameter for GetPath() or GetFullPath()
ERomRootPath	To get the root path in ROM.
EPhoneMemoryRootPath	To get the root path in Phone Memory.
EMemoryCardRootPath	To get the root path in Memory Card.
EGamesPath	To get the games path to be appended to a root path.
EInstallsPath	To get the installs path to be appended to a root path.
EOthersPath	To get the others path to be appended to a root path.
EVideosPath	To get the videos path to be appended to a root path.
EImagesPath	To get the images path to be appended to a root path.
EGsmPicturesPath	To get the GSM pictures path to be appended to a root path.
EMmsBackgroundImagesPath	To get the MMS pictures path to be appended to a root path.
EPresenceLogosPath	To get the presence logos path to be appended to a root path.
ESoundsPath	To get the sounds path to be appended to a root path.
EDigitalSoundsPath	To get the digital sounds path to be appended to a root path.
ESimpleSoundsPath	To get the simple sounds path to be appended to a root path.
EImagesThumbnailPath	To get the images thumbnail path. The thumbnail images directory exists under the same directory where the corresponding image is. Do not try to append this to a root directory.
EMemoryCardContactsPath	To get the full path of the contacts folder in the memory card. The path also contains the drive letter. Do not try to append this to any root directory.

Member Function Documentation

static IMPORT_C const TDesC& PathInfo::DigitalSoundsPath ( ) [static]

This method returns the digital sounds path to be appended to a root path.

Corresponding TSystemPaths value of the returned path is EDigitalSoundsPath.

Returns:: The digital sounds path.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::GamesPath ( ) [static]

This method returns the games path to be appended to a root path.

Corresponding TSystemPaths value of the returned path is EGamesPath.

Returns:: The games path.

See also:: TSystemPaths

static IMPORT_C TInt PathInfo::GetFullPath	(	TDes &	aFullPath,
		TInt	aDrive,
		TInt	aPath
	)	`[static]`

This method gets the full path of the requested system path in the requested drive.

KErrNotFound is returned when the drive has no requested system path or the requested path cannot be added to the root path.

Parameters:

	aFullPath	Stores the requested path, the maximum path length is KMaxPath.
	aDrive	A drive identifier specified by TDriveNumber.
	aPath	Defines the requested system path.

Returns:: A system wide error codes.

One small sample describing the usage of the method.

  #include <PathInfo.h>
  #include <DriveInfo.h>

  // Get the full path of the images folder in the default
  // phone memory drive.
  TFileName path;
  TInt drive;
  User::LeaveIfError( DriveInfo::GetDefaultDrive(
      DriveInfo::EDefaultPhoneMemory, drive ) );
  User::LeaveIfError( PathInfo::GetFullPath( path, drive, PathInfo::EImages ) );

  // 'path' contains now the full path of the images folder in the default
  // phone memory drive.

See also:

TDriveNumber

KMaxPath

TSystemPaths

DriveInfo

static IMPORT_C CDesCArray* PathInfo::GetListOfPathsL ( TInt aDrive ) [static]

This method gets the list of full system paths in the requested drive.

Parameters:

aDrive

A drive identifier specified by TDriveNumber.

Returns:: A list of the system paths. Ownership is transferred.

See also:: TDriveNumber

static IMPORT_C CDesCArray* PathInfo::GetListOfPathsLC ( TInt aDrive ) [static]

This method gets the list of full system paths in the requested drive and leaves the returned pointer in cleanup stack.

Parameters:

aDrive

A drive identifier specified by TDriveNumber.

Returns:: A list of the system paths. Ownership is transferred.

One small sample describing the usage of the method.

  #include <PathInfo.h>
  #include <DriveInfo.h>

  // Create the default path structure for default mass storage drive
  TInt drive;
  User::LeaveIfError( DriveInfo::GetDefaultDrive(
      DriveInfo::EDefaultMassStorage, drive ) );
  CDesCArray* paths = PathInfo::GetListOfPathsLC( drive );
  TInt count( paths->MdcaCount() );
  for ( TInt i( 0 ); i < count; ++i )
      {
      User::LeaveIfError( iFs.MkDirAll( paths->MdcaPoint( i ) );
      }
 CleanupStack::PopAndDestroy( paths );
 // The default mass storage drive contains now the default path structure

See also:: TDriveNumber
DriveInfo

static IMPORT_C const TDesC& PathInfo::GetPath ( TInt aPath ) [static]

This method returns the requested system path.

Parameters:

aPath

Defines the requested system path.

Returns:: The requested system path.

Panic:: EInvalidParameter Parameter aPath is invalid.

One small sample describing the usage of the method.

  #include <PathInfo.h>

  // Get the the full path of the contacts folder in the memory card.
  TFileName path = PathInfo::GetPath( PathInfo::EMemoryCardContactsPath );

  // 'path' contains now the full path of the contacts folder in the memory card..

See also:: TSystemPaths

static IMPORT_C TInt PathInfo::GetRootPath	(	TDes &	aRootPath,
		TInt	aDrive
	)	`[static]`

This method gets the root path of the requested drive.

The root path is the path where the system paths are located.

Parameters:

	aRootPath	Stores the path, the maximum path length is KMaxPath.
	aDrive	A drive identifier specified by TDriveNumber.

Returns:: A system wide error code.

One small sample describing the usage of the method.

  #include <PathInfo.h>
  #include <DriveInfo.h>

  // Get the root path of the default phone memory.
  TInt drive;
  User::LeaveIfError( DriveInfo::GetDefaultDrive(
      DriveInfo::EDefaultPhoneMemory, drive ) );
  TFileName path;
  User::LeaveIfError( PathInfo::GetRootPath( path, drive ) );

  // 'path' contains now the default folder root path of the default phone memory.

See also:

TDriveNumber

KMaxPath

DriveInfo

static IMPORT_C const TDesC& PathInfo::GmsPicturesPath ( ) [static]

This method returns the GMS pictures path to be appended to a root path.

Corresponding TSystemPaths value of the returned path is EGsmPicturesPath.

Returns:: The GSM pictures path.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::ImagesPath ( ) [static]

This method returns the images path to be appended to a root path.

Corresponding TSystemPaths value of the returned path is EImagesPath.

Returns:: The images path.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::ImagesThumbnailPath ( ) [static]

This method returns a thumbnail images path.

The thumbnail images directory exists under the same directory where the corresponding image is. Do not try to append this to a root directory. Corresponding TSystemPaths value of the returned path is EImagesThumbnailPath.

Returns:: The thumbnail images path.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::InstallsPath ( ) [static]

This method returns the installs path to be appended to a root path.

Corresponding TSystemPaths value of the returned path is EInstallsPath.

Returns:: The installs path.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::MemoryCardContactsPath ( ) [static]

This method returns the full path of the contacts folder in the memory card.

The path also contains the drive letter. Do not try to append this to any root directory. Corresponding TSystemPaths value of the returned path is EMemoryCardContactsPath.

Returns:: The full path of the contacts folder in the memory card.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::MemoryCardRootPath ( ) [static]

This method returns the root path in Memory Card.

Corresponding TSystemPaths value of the returned path is EMemoryCardRootPath.

Returns:: The root path in Memory Card.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::MmsBackgroundImagesPath ( ) [static]

This method returns the MMS background images path to be appended to a root path.

Corresponding TSystemPaths value of the returned path is EMmsBackgroundImagesPath.

Returns:: The MMS background images path.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::OthersPath ( ) [static]

This method returns the others path to be appended to a root path.

Corresponding TSystemPaths value of the returned path is EOthersPath.

Returns:: The installs path.

See also:: TSystemPaths

static IMPORT_C TInt PathInfo::PathType ( const TDesC & aFullPath ) [static]

This method returns the system path type of the given path.

Thumbnail system path can exist in any folder. Other paths must be exact system paths, not subfolders of a system path ENotSystemPath is returned, if the path is not a system path. The given path must have backslash ending.

Parameters:

aFullPath

A path to be type checked

Returns:: A value specified by TSystemPaths

One small sample describing the usage of the method.

  #include <PathInfo.h>

  // Check the type of the system path.
 _LIT( KImagesPath, "E:\\Images\\" );
  TInt type( PathInfo::PathType( KImagesPath ) );

  // 'type' contains now the EImagesPath value.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::PhoneMemoryRootPath ( ) [static]

This method returns the root path in Phone Memory.

Corresponding TSystemPaths value of the returned path is EPhoneMemoryRootPath.

Returns:: The root path in Phone Memory.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::PicturesPath ( ) [static]

This method returns the pictures path to be appended to a root path.

Corresponding TSystemPaths value of the returned path is EGsmPicturesPath.

Returns:: The pictures path.

Deprecated:: Use GmsPicturesPath() instead.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::PresenceLogosPath ( ) [static]

This method returns the presence logos path to be appended to a root path.

Corresponding TSystemPaths value of the returned path is EPresenceLogosPath.

Returns:: The presence logos path.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::RomRootPath ( ) [static]

This method returns the root path in ROM.

Corresponding TSystemPaths value of the returned path is ERomRootPath.

Returns:: The root path in ROM.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::SimpleSoundsPath ( ) [static]

This method returns the simple sounds path to be appended to a root path.

Corresponding TSystemPaths value of the returned path is ESimpleSoundsPath.

Returns:: The simple sound path.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::SoundsPath ( ) [static]

This method returns the sounds path to be appended to a root path.

Corresponding TSystemPaths value of the returned path is ESoundsPath.

Returns:: The sounds path.

See also:: TSystemPaths

static IMPORT_C const TDesC& PathInfo::VideosPath ( ) [static]

This method returns the videos path to be appended to a root path.

Corresponding TSystemPaths value of the returned path is EVideosPath.

Returns:: The videos path.

See also:: TSystemPaths

The documentation for this class was generated from the following file:

pathinfo.h

PathInfo Class Reference

Capability Information

Detailed Description

Public Types

Static Public Member Functions

Member Enumeration Documentation

Member Function Documentation